參考資料 › 函式參考 › 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

返回函式參考