Platform.roster_class.GetRosterClassObservation

Как вызывать

addon.Platform:GetRosterClassObservation(unit)

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

Что делает

Прочитать общедоступную идентичность состава на определённых семействах клиентов. Входные токены ограничены player, party1–party4 и raid1–raid40. Сначала вызывается UnitExists с этим точным токеном; известное false возвращает false без запроса класса. Для присутствующего юнита используется только второе возвращаемое значение UnitClass как читаемая непустая строка имени файла класса, без ограничения перечислением классов. Отсутствующие, неудачные, повреждённые или ограниченные обязательные факты возвращают nil с причиной.

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master (неявно при вызове через двоеточие).
`unit`	`string`	Точный токен player, party1..party4 или raid1..raid40, принадлежащий помощнику.

Возвращает

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

Издания

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

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

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

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

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

Пример

for index = 1, 4 do
  local class = addon.Platform:GetRosterClassObservation("party" .. index)
  if class == "PRIEST" then return true end
end
return false

Зависимости

rosterUnit → Platform.roster_class.rosterUnit

Исходный код

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

Platform.roster_class.GetRosterClassObservation(self, unit)

    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or not rosterUnit(unit) then return nil,'invalid-roster-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,'roster-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    if not exists then return false end
    if type(UnitClass)~='function' then return nil,'missing-api' end
    local success,_,class=pcall(UnitClass,unit)
    if not success then return nil,'api-error' end
    if not self:CanReadValue(class) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(class) then return nil,'restricted-value' end
    if class==nil then return nil,'roster-class-unavailable' end
    if type(class)~='string' or class=='' then return nil,'invalid-api-result' end
    return class

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