Platform.spells.GetSpellCooldown

Как вызывать

addon.Platform:GetSpellCooldown(spell)

Доступен напрямую через addon; зависимость не нужна.

Что делает

Считывает и нормализует время восстановления заклинания во всех поддерживаемых клиентах. Возвращаемая запись содержит startTime, duration, isEnabled и modRate. Метки времени и длительность уже описывают окончание в секундах GetTime(); не делите их на modRate. Когда клиент скрывает время (Retail и Forever в бою), запись равна nil с причиной restricted-value, а за ней следуют никогда не скрываемые флаги isEnabled, isActive и isOnGCD, если их удаётся прочитать.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master. При обращении через точку первым аргументом нужен addon.Platform; при вызове через двоеточие он передаётся неявно.
`spell`	`number \| string`	ID заклинания или распознаваемое клиентом название заклинания, восстановление которого нужно прочитать.

Возвращает

1	`table \| nil`	Читаемая запись восстановления или nil, если недоступно.
2	`string \| nil`	Причина недоступности или ошибки проверки, если запись равна nil.
3	`boolean \| nil`	Только при restricted-value: isEnabled — false, пока восстановление приостановлено.
4	`boolean \| nil`	Только при restricted-value: isActive — true, пока идёт восстановление (собственное или общее).
5	`boolean \| nil`	Только при restricted-value: isOnGCD — true, если текущее восстановление — общее время восстановления; может быть nil.

Издания

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

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

Игровой API
`C_Spell.GetSpellCooldown`
`GetSpellCooldown`

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

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

Пример

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

Зависимости

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

Исходный код

Platform/spells.lua, строка 393. В игре только для чтения; «Дублировать» создаёт редактируемую копию.

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

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