Platform.unit_metadata.GetUnitMetadataObservation

Как вызывать

addon.Platform:GetUnitMetadataObservation(unit, kind)

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

Что делает

Наблюдать одно используемое поле встроенных метаданных юнита после проверки UnitExists: class — второе значение UnitClass, creature — локализованное название UnitCreatureType, classification — UnitClassification. Читаемо отсутствующий юнит возвращает false без запроса метаданных. Неиспользуемые поля кортежа на доступность не влияют; отсутствующее, неудачное, nil, ограниченное или повреждённое обязательное значение возвращает nil с причиной. Класс игрока, GUID, перечисления или переводы не выводятся.

Аргументы

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

Возвращает

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

Издания

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

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

Игровой API
`UnitClass`
`UnitClassification`
`UnitCreatureType`
`UnitExists`

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

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

Пример

local classification = addon.Platform:GetUnitMetadataObservation("target", "classification")
if classification == nil then return nil end
return classification == "worldboss" or classification == "elite"

Исходный код

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

Platform.unit_metadata.GetUnitMetadataObservation(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~='class' and kind~='creature' and kind~='classification' then return nil,'invalid-unit-metadata-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=='class' then api=UnitClass
    elseif kind=='creature' then api=UnitCreatureType
    else api=UnitClassification end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,observed
    if kind=='class' then ok,observed=pcall(function() return select(2,api(unit)) end)
    else ok,observed=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(observed) then return nil,'restricted-value' end
    if observed==nil then return nil,'unit-metadata-unavailable' end
    if type(observed)~='string' or observed=='' then return nil,'invalid-api-result' end
    return observed

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