Platform.spells.GetSpellCooldown

Chame como

addon.Platform:GetSpellCooldown(spell)

Disponível diretamente por meio de addon; nenhuma dependência é necessária.

O que faz

Lê e normaliza o tempo de recarga de um feitiço nos clientes compatíveis. O registro retornado contém startTime, duration, isEnabled e modRate. Os carimbos de tempo e a duração já descrevem a expiração em segundos de GetTime(); não os divida por modRate. Quando o cliente oculta os tempos (Retail e Forever em combate), o registro é nil com o motivo restricted-value, seguido das flags isEnabled, isActive e isOnGCD, que nunca são secretas, quando podem ser lidas.

Argumentos

Nome	Tipo	O que faz
`self`	`RMPlatform`	Adaptador de plataforma do Rotation Master. Uma referência com ponto exige addon.Platform como primeiro argumento; uma chamada com dois-pontos o fornece implicitamente.
`spell`	`number \| string`	ID de feitiço ou nome de feitiço reconhecido pelo cliente cujo tempo de recarga deve ser lido.

Retornos

1	`table \| nil`	Registro de tempo de recarga legível, ou nil quando indisponível.
2	`string \| nil`	Motivo de disponibilidade ou de validação quando o registro é nil.
3	`boolean \| nil`	Somente com restricted-value: isEnabled, false enquanto o tempo de recarga está suspenso.
4	`boolean \| nil`	Somente com restricted-value: isActive, true enquanto um tempo de recarga (o próprio ou o global) está em andamento.
5	`boolean \| nil`	Somente com restricted-value: isOnGCD, true quando o tempo de recarga em andamento é o tempo de recarga global; pode ser nil.

Edições

As funções auxiliares integradas são registradas em todas as edições. O que muda é a API do jogo que elas leem; quando uma está ausente, a função auxiliar recorre a uma alternativa ou retorna nil com um motivo.

Indisponível nessa edição (o motivo está na dica)
Só enquanto as alternativas da Blizzard para APIs obsoletas estiverem ativas

API do jogo
`C_Spell.GetSpellCooldown`
`GetSpellCooldown`

Valores secretos (Retail e Forever)

No Retail e no Forever, o jogo entrega valores secretos aos addons. Esta função auxiliar verifica o que lê (addon.Platform:CanReadValue) e retorna nil com um motivo como restricted-value em vez de um valor secreto que não consegue comparar. Trate nil como indisponível, não como false.

Exemplo

local record, reason, isEnabled, isActive = addon.Platform:GetSpellCooldown(value.spell)
if record then return record.isEnabled and record.duration == 0 end
-- Times are secret in combat on Retail and Forever; fall back to the flags.
if reason == "restricted-value" and isActive ~= nil then return isEnabled and not isActive end
return nil

Dependências

cooldownFields (builtin:Platform/spells.lua:cooldownFields)
cooldownFlags → Platform.spells.cooldownFlags
identifier → Platform.spells.identifier
own → Platform.spells.own

Código-fonte

Platform/spells.lua, linha 393. Somente leitura no jogo; Duplicar cria uma cópia editável.

Platform.spells.GetSpellCooldown(self, spell)

    local valid, reason = identifier(spell)
    if not valid then return nil, reason end
    local ok, record, built
    if C_Spell and type(C_Spell.GetSpellCooldown) == "function" then
        ok, record = pcall(C_Spell.GetSpellCooldown, spell)
    elseif type(GetSpellCooldown) == "function" then
        local start, duration, enabled, rate
        ok, start, duration, enabled, rate = pcall(GetSpellCooldown, spell)
        if not ok then return nil, "api-error" end
        if not self:CanReadValue(start) or not self:CanReadValue(duration) or not self:CanReadValue(enabled)
            or not self:CanReadValue(rate) then return nil, "restricted-value" end
        if start ~= nil then
            if enabled ~= 0 and enabled ~= 1 then return nil, "invalid-api-result" end
            record = {startTime=start, duration=duration, isEnabled=enabled == 1, modRate=rate or 1};built = true
        end
    else return nil, "missing-api" end
    if not ok then return nil, "api-error" end
    if not self:CanReadValue(record) then return nil, "restricted-value" end
    if record == nil then return nil, "spell-data-unavailable" end
    local cooldown, why = own(record, cooldownFields, built)
    if not cooldown then
        if why == "restricted-value" and not built then return nil, why, cooldownFlags(self, record) end
        return nil, why
    end
    if cooldown.startTime == nil or cooldown.duration == nil or cooldown.isEnabled == nil
        or cooldown.startTime < 0 or cooldown.duration < 0 or (cooldown.modRate and cooldown.modRate <= 0) then
        return nil, "invalid-api-result"
    end
    cooldown.modRate = cooldown.modRate or 1
    return cooldown

Voltar para Referência de funções