Справочник › Справочник функций › Platform

Platform.unit_states.GetUnitStateObservation

общедоступный

Как вызывать

addon.Platform:GetUnitStateObservation(unit, kind)

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

Что делает

Наблюдать состояние смерти или призрака либо дружелюбие к игроку для точного выбранного юнита на клиентах с политикой проверки или ограничения. Отсутствующее, неудачное, ограниченное или повреждённое обязательное наблюдение недоступно. Отсутствие юнита — это «недоступно», а не отрицательное совпадение, в том числе под НЕ. Состояние между опросами не сохраняется.

Аргументы

ИмяТипЧто делает
selfRMPlatformАдаптер платформы Rotation Master (неявно при вызове через двоеточие).
unitstringТочный непустой токен наблюдаемого юнита.
kindstringРовно dead для UnitIsDeadOrGhost или friendly для UnitIsFriend(player, unit).

Возвращает

1boolean | nilЧитаемое текущее состояние или nil, если недоступно.
2string | nilПричина недоступности или ошибки проверки запроса, если текущее состояние нельзя прочитать.

Издания

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

  • Недоступно в этом издании (причина — во всплывающей подсказке)
  • Только пока включены запасные реализации Blizzard для устаревших функций
Игровой APIClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsDeadOrGhostClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsFriendClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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

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

Пример

local friendly = addon.Platform:GetUnitStateObservation("target", "friendly")
local dead = addon.Platform:GetUnitStateObservation("target", "dead")
if friendly == nil or dead == nil then return nil end
return friendly and dead -- a friend to resurrect

Исходный код

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

Platform.unit_states.GetUnitStateObservation(self, unit, kind)
    local policy=self:GetCombatDataPolicy()
    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~='dead' and kind~='friendly' then return nil,'invalid-unit-state-query' end
    local existsAPI=UnitExists
    if type(existsAPI)~='function' then return nil,'missing-api' end
    local existsOK,exists=pcall(existsAPI,unit)
    if not existsOK then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil or exists==false then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local api
    if kind=='dead' then api=UnitIsDeadOrGhost else api=UnitIsFriend end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='friendly' 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-state-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

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