Platform.form.GetPlayerFormObservation

Как вызывать

addon.Platform:GetPlayerFormObservation()

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

Что делает

Наблюдать текущий облик игрока одним защищённым вызовом GetShapeshiftForm без аргументов. Сохраняется любой читаемый конечный числовой результат, включая ноль, знаковые и дробные значения; более строгая область индексов не выводится. Отсутствующие, неудачные, nil, ограниченные или бесконечные данные остаются недоступными. Число обликов, класс, ID заклинания, юнит или необязательный аргумент не добавляются.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master (неявно при вызове через двоеточие).

Возвращает

1	`number \| nil`	Читаемое конечное наблюдение текущего облика, включая ноль для сравнения «без облика»; nil, если недоступно.
2	`string \| nil`	Причина недоступности по политике клиента, возможности, вызову или наблюдению для облика nil.

Издания

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

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

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

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

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

Пример

local form = addon.Platform:GetPlayerFormObservation()
if form == nil then return nil end
return form == 0 -- not shapeshifted

Исходный код

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

Platform.form.GetPlayerFormObservation(self)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if type(GetShapeshiftForm)~='function' then return nil,'missing-api' end
    local ok,result=pcall(GetShapeshiftForm)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'form-unavailable' end
    if type(result)~='number' or result~=result or result==math.huge or result==-math.huge then return nil,'invalid-api-result' end
    return result

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