Platform.groups.GetGroupMembership

Как вызывать

addon.Platform:GetGroupMembership(raidOnly)

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

Что делает

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

Аргументы

Имя	Тип	Что делает
`self`	`RMPlatform`	Адаптер платформы Rotation Master (неявно при вызове через двоеточие).
`raidOnly`	`boolean \| nil`	true запрашивает членство в рейде; false или nil — членство в любой группе.

Возвращает

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

Издания

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

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

Игровой API
`IsInGroup`
`IsInRaid`

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

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

Пример

local grouped = addon.Platform:GetGroupMembership(false)
local raid = addon.Platform:GetGroupMembership(true)
if grouped == nil or raid == nil then return nil end
return grouped and not raid -- in a party, not a raid

Исходный код

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

Platform.groups.GetGroupMembership(self, raidOnly)

    if not self:CanReadValue(raidOnly) then return nil,'restricted-value' end
    if raidOnly~=nil and type(raidOnly)~='boolean' then return nil,'invalid-group-query' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    local fn
    if raidOnly then fn=IsInRaid else fn=IsInGroup end
    if type(fn)~='function' then return nil,'missing-api' end
    local ok,member=pcall(fn)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(member) then return nil,'restricted-value' end
    if member==nil then return nil,'group-data-unavailable' end
    if type(member)~='boolean' then return nil,'invalid-api-result' end
    return member

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