Platform.groups.GetUnitGroupMembership

Как вызывать

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

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

Что делает

Прочитать членство указанного юнита в группе или рейде игрока. При raidOnly true запрашивается только UnitInRaid; иначе результат true от UnitInParty завершает проверку, false переходит к UnitInRaid, а неизвестный остаётся недоступным. Читаемый индекс рейда nil означает false; целый индекс рейда 1..40 — true. Имена передаются встроенным API без изменений; приём имён встроенным запросом зависит от квалификации клиента.

Аргументы

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

Возвращает

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

Издания

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

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

Игровой API
`UnitInParty`
`UnitInRaid`
`canaccessvalue`

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

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

Пример

local member = addon.Platform:GetUnitGroupMembership("focus", false)
if member == nil then return nil end
return member

Исходный код

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

Platform.groups.GetUnitGroupMembership(self, unit, raidOnly)

    if not self:CanReadValue(unit) or not self:CanReadValue(raidOnly) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' or #unit>512 or unit:find('[%z\1-\31\127]') then return nil,'invalid-unit' 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
    if not raidOnly then
        if type(UnitInParty)~='function' then return nil,'missing-api' end
        local ok,member=pcall(UnitInParty,unit)
        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
        if member then return true end
    end
    if type(UnitInRaid)~='function' then return nil,'missing-api' end
    local ok,index=pcall(UnitInRaid,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(index) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(index) then return nil,'restricted-value' end
    -- The pinned native API returns an optional raid index: nil is nonmember.
    if index==nil then return false end
    if type(index)~='number' or index<1 or index>40 or index%1~=0 then return nil,'invalid-api-result' end
    return true

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