Platform.loss_of_control.GetLossOfControlEvent

Как вызывать

addon.Platform:GetLossOfControlEvent(index, kind)

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

Что делает

Прочитать одну документированную строку активной потери контроля по её встроенному индексу и запрошенному виду субъекта. Запросы типа требуют только читаемой строки типа контроля; запросы школы — только читаемой конечной неотрицательной целой маски школы. Необязательное время возвращается как конечное timeRemaining или явная причина для поля, поэтому для постороннего субъекта рабочий таймер не нужен. Отсутствующие строки — недоступные наблюдения снимка. Поля отображения, выведенный срок, сумма длительностей, максимум или запасные встроенные псевдонимы не используются.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master (неявно при вызове через двоеточие).
`index`	`number`	Встроенный целочисленный индекс активной строки (с единицы) в пределах бюджета сканирования RM в 256 строк.
`kind`	`string`	Ровно type или school; выбирает нужное поле субъекта, не требуя другого.

Возвращает

1	`table \| nil`	Нормализованный запрошенный субъект с конечным timeRemaining или timeRemainingReason; nil, если обязательная строка или субъект недоступны.
2	`string \| nil`	Причина недоступности по политике, запросу, возможности или обязательной строке/субъекту для записи nil.

Издания

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

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

Игровой API
`C_LossOfControl`
`canaccessvalue`

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

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

Пример

local count = addon.Platform:GetLossOfControlCount()
if count == nil then return nil end
if count == 0 then return false end
local row = addon.Platform:GetLossOfControlEvent(1, "type")
if not row then return nil end
return row.locType == "STUN"

Исходный код

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

Platform.loss_of_control.GetLossOfControlEvent(self, index, kind)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(index) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(index) then return nil,'restricted-value' end
    if type(index)~='number' or index~=index or index==math.huge or index==-math.huge or index<1 or index%1~=0 then return nil,'invalid-loss-of-control-query' end
    if kind~='type' and kind~='school' then return nil,'invalid-loss-of-control-query' end
    if index>256 then return nil,'loss-of-control-budget-exceeded' end
    local namespace=C_LossOfControl
    if not self:CanReadValue(namespace) then return nil,'restricted-value' end
    if type(namespace)~='table' then return nil,'missing-api' end
    local methodOk,method=pcall(function() return namespace.GetActiveLossOfControlData end)
    if not methodOk then return nil,'api-error' end
    if not self:CanReadValue(method) then return nil,'restricted-value' end
    if type(method)~='function' then return nil,'missing-api' end
    local ok,event=pcall(method,index)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(event) then return nil,'restricted-value' end
    if event==nil then return nil,'loss-of-control-event-unavailable' end
    if type(event)~='table' then return nil,'invalid-api-result' end
    local subjectOk,subject=pcall(function() return event[kind=='type' and 'locType' or 'lockoutSchool'] end)
    if not subjectOk then return nil,'api-error' end
    if not self:CanReadValue(subject) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(subject) then return nil,'restricted-value' end
    if subject==nil then return nil,'loss-of-control-subject-unavailable' end
    local record={}
    if kind=='type' then
        if type(subject)~='string' then return nil,'invalid-api-result' end
        record.locType=subject
    else
        if type(subject)~='number' or subject~=subject or subject==math.huge or subject==-math.huge or subject<0 or subject%1~=0 then return nil,'invalid-api-result' end
        record.lockoutSchool=subject
    end
    local timeOk,remaining=pcall(function() return event.timeRemaining end)
    if not timeOk then record.timeRemainingReason='api-error'
    elseif not self:CanReadValue(remaining) then record.timeRemainingReason='restricted-value'
    elseif canaccessvalue and not canaccessvalue(remaining) then record.timeRemainingReason='restricted-value'
    elseif remaining==nil then record.timeRemainingReason='loss-of-control-time-unavailable'
    elseif type(remaining)~='number' or remaining~=remaining or remaining==math.huge or remaining==-math.huge then record.timeRemainingReason='invalid-api-result'
    else record.timeRemaining=remaining end
    return record

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