Platform.unit_flags.GetUnitFlagObservation

Как вызывать

addon.Platform:GetUnitFlagObservation(unit, kind)

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

Что делает

Наблюдать один текущий флаг юнита: combat — UnitAffectingCombat, enemy — UnitIsEnemy с player первым юнитом, pvp — UnitIsPVP. Читаемо отсутствующий юнит возвращает false без запроса флага. Отсутствующие, неудачные, ограниченные или повреждённые обязательные наблюдения возвращают nil с причиной. Точный выбранный юнит сохраняется; дружелюбие, возможность атаки и другие состояния юнита не выводятся.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master (неявно при вызове через двоеточие).
`unit`	`string`	Точный токен юнита, выбранный флаг которого наблюдается.
`kind`	`string`	Одно из combat, enemy или pvp; другие виды флагов не поддерживаются.

Возвращает

1	`boolean \| nil`	Читаемый выбранный флаг, false для известного отсутствующего юнита или nil, если обязательное наблюдение недоступно.
2	`string \| nil`	Причина по политике, проверке запроса или недоступности для флага юнита nil.

Издания

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

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

Игровой API
`UnitAffectingCombat`
`UnitExists`
`UnitIsEnemy`
`UnitIsPVP`

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

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

Пример

local inCombat = addon.Platform:GetUnitFlagObservation("target", "combat")
local enemy = addon.Platform:GetUnitFlagObservation("target", "enemy")
if inCombat == nil or enemy == nil then return nil end
return enemy and not inCombat

Зависимости

readClientPolicy (builtin:Platform/unit_flags.lua:readClientPolicy)

Исходный код

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

Platform.unit_flags.GetUnitFlagObservation(self, unit, kind)

    local policy=readClientPolicy(self)
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if kind~='combat' and kind~='enemy' and kind~='pvp' then return nil,'invalid-unit-flag-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local existsOk,exists=pcall(UnitExists,unit)
    if not existsOk then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    if not exists then return false end
    local api
    if kind=='combat' then api=UnitAffectingCombat
    elseif kind=='enemy' then api=UnitIsEnemy
    else api=UnitIsPVP end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='enemy' then ok,result=pcall(api,'player',unit)
    else ok,result=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'unit-flag-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

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