参考 › 函数参考 › Platform

Platform.casting.spellIdentity

依赖项

调用方式

Platform.casting.spellIdentity(id)

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

作用

Validates the spell ID field of a cast or channel result. Returns the ID when it is a readable positive finite integer; otherwise nil with "restricted-value" (secret), "cast-spell-unavailable" (nil) or "invalid-api-result".

参数

名称类型作用
idanySpell ID value from the UnitCastingInfo or UnitChannelInfo result.

返回值

1number | nilThe validated spell ID, or nil when unavailable.
2string | nilReason when the ID is nil.

版本

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

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

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

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

插件如何调用它

依赖项

源码

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

Platform.casting.spellIdentity(id)
    if not platform:CanReadValue(id) then return nil,'restricted-value' end
    if id==nil then return nil,'cast-spell-unavailable' end
    if type(id)~='number' or id~=id or id<=0 or id==math.huge or id%1~=0 then return nil,'invalid-api-result' end
    return id

返回函数参考