Platform.pet.GetPetObservation

Как вызывать

addon.Platform:GetPetObservation(includeName)

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

Что делает

Наблюдать точное существование питомца и, при необходимости, его отформатированное отображаемое имя через GetUnitName. Запросы только присутствия никогда не требуют имени. При известном отсутствии запрос имени пропускается. Для присутствующих питомцев читаемое непустое имя требуется только по запросу; отсутствующие, неудачные, nil, ограниченные или повреждённые обязательные наблюдения возвращают nil с причиной. Помощник отображения вызывается с единственным исходным аргументом питомца, без запасного UnitName и без выводов о панели, здоровье или способностях.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master (неявно при вызове через двоеточие).
`includeName`	`boolean \| nil`	true запрашивает отформатированное имя питомца; false или опущенное значение читает только присутствие.

Возвращает

1	`table \| nil`	Наблюдение питомца с логическим exists и, для запрошенного присутствующего питомца, name; nil, если обязательные данные недоступны.
2	`string \| nil`	Причина по политике, проверке запроса или недоступности для наблюдения питомца nil.

Издания

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

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

Игровой API
`GetUnitName`
`UnitExists`
`canaccessvalue`

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

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

Пример

local pet = addon.Platform:GetPetObservation(false)
if not pet then return nil end
return not pet.exists -- time to summon

Исходный код

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

Platform.pet.GetPetObservation(self, includeName)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(includeName) then return nil,'restricted-value' end
    if includeName~=nil and type(includeName)~='boolean' then return nil,'invalid-pet-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,'pet')
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'pet-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local record={exists=exists}
    if not exists or not includeName then return record end
    if type(GetUnitName)~='function' then return nil,'missing-api' end
    local nameOk,name=pcall(GetUnitName,'pet')
    if not nameOk then return nil,'api-error' end
    if not self:CanReadValue(name) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(name) then return nil,'restricted-value' end
    if name==nil then return nil,'pet-name-unavailable' end
    if type(name)~='string' or name=='' then return nil,'invalid-api-result' end
    record.name=name
    return record

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