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

Platform.unit_presence.GetUnitPresenceObservation

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

Как вызывать

addon.Platform:GetUnitPresenceObservation(unit)

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

Что делает

Наблюдать присутствие юнита на определённых семействах клиентов. Выбранный юнит передаётся без изменений в один защищённый вызов UnitExists. Читаемые true и false сохраняются; отсутствующие, неудачные, ограниченные, nil или повреждённые обязательные наблюдения возвращают nil с причиной. Запросы идентичности, видимости, дальности или боевого состояния не добавляются.

Аргументы

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

Возвращает

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

Издания

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

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

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

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

Пример

local present = addon.Platform:GetUnitPresenceObservation("focus")
if present == nil then return nil end
return not present

Исходный код

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

Platform.unit_presence.GetUnitPresenceObservation(self, unit)
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,unit)
    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,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    return exists

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