參考資料 › 函式參考 › Platform

Platform.spells.cooldownValues

相依項目

呼叫方式

Platform.spells.cooldownValues(self, spell)

記錄相依項目 Platform.spells.cooldownValues,然後以該名稱呼叫。含命名空間的呼叫不會傳入 self:請使用冒號呼叫,或自行傳入該物件。

作用

Reads a spell cooldown as separate values for the readiness checks. When the platform is marked secretsUnrestricted and the legacy GetSpellCooldown exists it calls that directly; otherwise it uses addon.Platform:GetSpellCooldown, passing along its never-secret flags when the times are restricted.

參數

名稱類型作用
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
spellnumber | stringSpell ID or client-recognized spell name.

傳回值

1number | nilCooldown start time in GetTime() seconds; nil when unavailable.
2number | nilCooldown duration in seconds; nil when unavailable.
3boolean | nilWhether the cooldown is enabled; when the times are unavailable, the never-secret isEnabled flag if it could be read.
4string | nilReason when the times are unavailable.
5boolean | nilWith restricted-value from GetSpellCooldown only: isActive.
6boolean | nilWith restricted-value from GetSpellCooldown only: isOnGCD; may be nil.

版本

內建輔助函式在每個版本上都會註冊。不同的是它們讀取的遊戲 API;某個 API 不存在時,輔助函式會改用備用方式,或傳回 nil 並附上原因。

  • 該版本無法使用(原因請見提示)
  • 僅在暴雪的棄用相容層開啟時
遊戲 API經典時代TBC 週年版經典進程永久正式版
GetSpellCooldown經典時代TBC 週年版經典進程永久正式版

機密值(正式版與永久)

在正式版與永久上,遊戲交給插件的是機密值。此輔助函式會檢查它讀取的內容(addon.Platform:CanReadValue),遇到無法比較的機密值時,會傳回 nil 並附上原因(例如 restricted-value),而不是傳回該機密值。請將 nil 視為無法使用,而非假。

插件如何呼叫它

相依項目

原始碼

Platform/spells.lua,第 507 行。在遊戲中為唯讀;「複製」會產生一份可編輯的複本。

Platform.spells.cooldownValues(self, spell)
    local legacy=self.secretsUnrestricted and GetSpellCooldown
    if type(legacy)~="function" then
        local cooldown,reason,enabled,active,onGCD=self:GetSpellCooldown(spell)
        if not cooldown then return nil,nil,enabled,reason,active,onGCD end
        return cooldown.startTime,cooldown.duration,cooldown.isEnabled
    end
    local valid,reason=identifier(spell)
    if not valid then return nil,nil,nil,reason end
    local ok,start,duration,enabled=pcall(legacy,spell)
    if not ok then return nil,nil,nil,"api-error" end
    if not self:CanReadValue(start) or not self:CanReadValue(duration) or not self:CanReadValue(enabled) then
        return nil,nil,nil,"restricted-value"
    end
    if start==nil then return nil,nil,nil,"spell-data-unavailable" end
    if enabled~=0 and enabled~=1 and enabled~=true and enabled~=false then return nil,nil,nil,"invalid-api-result" end
    if not finiteNonNegative(start) or not finiteNonNegative(duration) then return nil,nil,nil,"invalid-api-result" end
    return start,duration,enabled==1 or enabled==true

返回函式參考