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.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Rotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
`spell`	`number \| string`	Spell ID or client-recognized spell name.

Возвращает

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

Издания

Встроенные помощники регистрируются во всех изданиях. Различается игровой API, который они читают; если нужного API нет, помощник использует запасной вариант или возвращает nil с причиной.

Недоступно в этом издании (причина — во всплывающей подсказке)
Только пока включены запасные реализации Blizzard для устаревших функций

Игровой API
`GetSpellCooldown`

Секретные значения (Retail и Forever)

В Retail и Forever игра передаёт аддонам секретные значения. Этот помощник проверяет то, что читает (addon.Platform:CanReadValue), и вместо секретного значения, которое нельзя сравнить, возвращает nil с причиной, например restricted-value. Считайте nil недоступным значением, а не ложью.

Как его вызывает аддон

Platform.spells.IsSpellReady

local start,duration,enabled,reason,active,onGCD=cooldownValues(self,spell)

Platform.spells.gcdRunning

local start,duration,enabled,why,active=cooldownValues(self,gcdSpell)

Зависимости

finiteNonNegative → Platform.spells.finiteNonNegative
identifier → Platform.spells.identifier

Исходный код

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

Назад: Справочник функций