Platform.groups.GetUnitGroupMembership

Chame como

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

Disponível diretamente por meio de addon; nenhuma dependência é necessária.

O que faz

Lê a participação de uma unidade especificada no grupo ou na raide do jogador. Com raidOnly true, consulta apenas UnitInRaid; caso contrário, um resultado true de UnitInParty encerra a verificação, false passa para UnitInRaid e desconhecido continua indisponível. Um índice de raide nil legível significa false; um índice de raide inteiro 1..40 significa true. Os nomes são passados sem alteração às APIs nativas; a aceitação de nomes pela consulta nativa exige a qualificação do cliente.

Argumentos

Nome	Tipo	O que faz
`self`	`RMPlatform`	Adaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
`unit`	`string`	Token de unidade legível e não vazio ou nome reconhecido nativamente, passado sem alteração.
`raidOnly`	`boolean \| nil`	True verifica apenas a participação na raide; false ou nil verificam o grupo e depois a raide.

Retornos

1	`boolean \| nil`	Participação observada, ou nil quando indisponível.
2	`string \| nil`	Motivo de validação ou disponibilidade para um resultado nil.

Edições

As funções auxiliares integradas são registradas em todas as edições. O que muda é a API do jogo que elas leem; quando uma está ausente, a função auxiliar recorre a uma alternativa ou retorna nil com um motivo.

Indisponível nessa edição (o motivo está na dica)
Só enquanto as alternativas da Blizzard para APIs obsoletas estiverem ativas

API do jogo
`UnitInParty`
`UnitInRaid`
`canaccessvalue`

Valores secretos (Retail e Forever)

No Retail e no Forever, o jogo entrega valores secretos aos addons. Esta função auxiliar verifica o que lê (addon.Platform:CanReadValue) e retorna nil com um motivo como restricted-value em vez de um valor secreto que não consegue comparar. Trate nil como indisponível, não como false.

Exemplo

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

Código-fonte

Platform/groups.lua, linha 45. Somente leitura no jogo; Duplicar cria uma cópia editável.

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

Voltar para Referência de funções