参考 › 函数参考 › Platform

Platform.spells.identifier

依赖项

调用方式

Platform.spells.identifier(value, idOnly)

记录依赖项 Platform.spells.identifier,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。

作用

Validates a spell argument. Accepts a readable positive finite integer spell ID or, unless idOnly is true, a nonempty spell name string. Returns true, or false with "restricted-value" for a secret value or "invalid-spell" for anything else.

参数

名称类型作用
valueanySpell ID or name to validate.
idOnlyboolean | nilTrue accepts numeric spell IDs only and rejects names.

返回值

1booleanTrue when value is acceptable; false otherwise.
2string | nilrestricted-value or invalid-spell when rejected.

版本

内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API;某个 API 缺失时,辅助函数会改用后备方案,或返回 nil 并附上原因。

它不直接读取任何游戏 API。

秘密值(正式服和永久服)

在正式服和永久服上,游戏交给插件的是秘密值。此辅助函数会检查它读取的内容(addon.Platform:CanReadValue),遇到无法比较的秘密值时返回 nil 并附上原因(例如 restricted-value),而不是返回该秘密值。请将 nil 视为不可用,而不是假。

插件如何调用它

依赖项

源码

Platform/spells.lua,第 22 行。在游戏中为只读;“复制”会生成一份可编辑的副本。

Platform.spells.identifier(value, idOnly)
    if not platform:CanReadValue(value) then return false, "restricted-value" end
    if type(value) == "number" and value > 0 and value < math.huge and value % 1 == 0 then return true end
    if not idOnly and type(value) == "string" and #value > 0 then return true end
    return false, "invalid-spell"

返回函数参考