Platform.spells.GetSpellCooldown

Llamar como

addon.Platform:GetSpellCooldown(spell)

Disponible directamente a través de addon; no hace falta ninguna dependencia.

Qué hace

Lee y normaliza el tiempo de reutilización de un hechizo en todos los clientes compatibles. El registro devuelto contiene startTime, duration, isEnabled y modRate. Las marcas de tiempo y la duración ya describen la expiración en segundos de GetTime(); no las dividas entre modRate. Cuando el cliente oculta los tiempos (Retail y Forever en combate), el registro es nil con el motivo restricted-value, seguido de los indicadores isEnabled, isActive e isOnGCD, que nunca son secretos, cuando se pueden leer.

Argumentos

Nombre	Tipo	Qué hace
`self`	`RMPlatform`	Adaptador de plataforma de Rotation Master. Una referencia con punto requiere addon.Platform como primer argumento; una llamada con dos puntos lo proporciona de forma implícita.
`spell`	`number \| string`	ID de hechizo o nombre de hechizo reconocido por el cliente cuyo tiempo de reutilización se debe leer.

Retornos

1	`table \| nil`	Registro de tiempo de reutilización legible, o nil si no está disponible.
2	`string \| nil`	Motivo de disponibilidad o de validación cuando el registro es nil.
3	`boolean \| nil`	Solo con restricted-value: isEnabled, false mientras el tiempo de reutilización está en pausa.
4	`boolean \| nil`	Solo con restricted-value: isActive, true mientras hay un tiempo de reutilización (el propio o el global) en curso.
5	`boolean \| nil`	Solo con restricted-value: isOnGCD, true cuando el tiempo de reutilización en curso es el global; puede ser nil.

Ediciones

Las funciones auxiliares integradas se registran en todas las ediciones. Lo que cambia es la API del juego que leen; donde falta alguna, la función auxiliar recurre a una alternativa o devuelve nil con un motivo.

No disponible en esa edición (el motivo aparece en la información emergente)
Solo mientras estén activas las alternativas de Blizzard para API obsoletas

API del juego
`C_Spell.GetSpellCooldown`
`GetSpellCooldown`

Valores secretos (Retail y Forever)

En Retail y Forever, el juego entrega a los addons valores secretos. Esta función auxiliar comprueba lo que lee (addon.Platform:CanReadValue) y, en lugar de un secreto que no puede comparar, devuelve nil con un motivo como restricted-value. Trata nil como no disponible, no como falso.

Ejemplo

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

Dependencias

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

Código fuente

Platform/spells.lua, línea 393. Solo lectura en el juego; Duplicar crea una copia editable.

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

Volver a Referencia de funciones