Referência › Referência de funções › Platform

Platform.groups.GetGroupMembership

pública

Chame como

addon.Platform:GetGroupMembership(raidOnly)

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

O que faz

Lê a participação pública em grupo em famílias de cliente identificadas. Clientes desconhecidos não são suportados. Com raidOnly true verifica IsInRaid; com false ou nil verifica IsInGroup usando a categoria de grupo nativa padrão. Um resultado false legível continua false. Observações ausentes, com falha, malformadas ou restritas retornam nil com um motivo.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
raidOnlyboolean | nilTrue solicita a participação na raide; false ou nil solicitam a participação em qualquer grupo.

Retornos

1boolean | nilParticipação observada, ou nil quando indisponível.
2string | nilMotivo 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 jogoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
IsInGroupClassic EraTBC AnniversaryClassic ProgressionForeverRetail
IsInRaidClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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 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

Código-fonte

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

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

Voltar para Referência de funções