参考 › 函数参考 › 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

返回函数参考