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

返回函式參考