Platform.spells.GetSpellCooldown

Chiamala come

addon.Platform:GetSpellCooldown(spell)

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Legge e normalizza il tempo di recupero di un incantesimo su tutti i client supportati. Il record restituito contiene startTime, duration, isEnabled e modRate. Gli istanti e la durata descrivono già la scadenza in secondi di GetTime(); non dividerli per modRate. Quando il client nasconde i tempi (Retail e Forever in combattimento) il record è nil con motivo restricted-value, seguito dai flag isEnabled, isActive e isOnGCD, mai segreti, quando possono essere letti.

Argomenti

Nome	Tipo	Cosa fa
`self`	`RMPlatform`	Adattatore di piattaforma di Rotation Master. Un riferimento con punto richiede addon.Platform come primo argomento; una chiamata con due punti lo fornisce implicitamente.
`spell`	`number \| string`	ID dell'incantesimo o nome riconosciuto dal client di cui leggere il tempo di recupero.

Valori restituiti

1	`table \| nil`	Record leggibile del tempo di recupero, oppure nil se non disponibile.
2	`string \| nil`	Motivo di indisponibilità o di convalida quando il record è nil.
3	`boolean \| nil`	Solo con restricted-value: isEnabled, false mentre il tempo di recupero è sospeso.
4	`boolean \| nil`	Solo con restricted-value: isActive, true mentre è in corso un tempo di recupero (il proprio o quello globale).
5	`boolean \| nil`	Solo con restricted-value: isOnGCD, true quando il tempo di recupero in corso è quello globale; può essere nil.

Edizioni

Le funzioni di supporto integrate sono registrate su ogni edizione. Ciò che cambia è l'API di gioco che leggono; dove ne manca una, la funzione di supporto ripiega su un'alternativa o restituisce nil con un motivo.

Non disponibile su quell'edizione (il motivo è nel suggerimento)
Solo mentre sono attivi i ripieghi di Blizzard per le API deprecate

API di gioco
`C_Spell.GetSpellCooldown`
`GetSpellCooldown`

Valori segreti (Retail e Forever)

Su Retail e Forever il gioco fornisce agli addon valori segreti. Questa funzione di supporto controlla ciò che legge (addon.Platform:CanReadValue) e restituisce nil con un motivo come restricted-value invece di un valore segreto che non può confrontare. Considera nil come non disponibile, non come false.

Esempio

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

Dipendenze

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

Sorgente

Platform/spells.lua, riga 393. Nel gioco è in sola lettura; Duplica crea una copia modificabile.

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

Torna a Riferimento delle funzioni