Platform.groups.GetGroupMembership

Chiamala come

addon.Platform:GetGroupMembership(raidOnly)

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Legge l'appartenenza pubblica al gruppo sulle famiglie di client identificate. I client sconosciuti non sono supportati. Con raidOnly true controlla IsInRaid; con false o nil controlla IsInGroup usando la categoria di gruppo nativa predefinita. Un risultato false leggibile resta false. Osservazioni mancanti, fallite, malformate o soggette a restrizioni restituiscono nil con un motivo.

Argomenti

Nome	Tipo	Cosa fa
`self`	`RMPlatform`	Adattatore di piattaforma di Rotation Master (implicito nelle chiamate con due punti).
`raidOnly`	`boolean \| nil`	True richiede l'appartenenza a un'incursione; false o nil richiede l'appartenenza a qualsiasi gruppo.

Valori restituiti

1	`boolean \| nil`	Appartenenza osservata, oppure nil se non disponibile.
2	`string \| nil`	Motivo di convalida o di indisponibilità quando il risultato è nil.

Edizioni

Le funzioni di supporto integrate sono registrate su ogni edizione. Ciò che cambia è l'API di gioco che leggono; dove ne manca una, la funzione di supporto ripiega su un'alternativa o restituisce nil con un motivo.

Non disponibile su quell'edizione (il motivo è nel suggerimento)
Solo mentre sono attivi i ripieghi di Blizzard per le API deprecate

API di gioco
`IsInGroup`
`IsInRaid`

Valori segreti (Retail e Forever)

Su Retail e Forever il gioco fornisce agli addon valori segreti. Questa funzione di supporto controlla ciò che legge (addon.Platform:CanReadValue) e restituisce nil con un motivo come restricted-value invece di un valore segreto che non può confrontare. Considera nil come non disponibile, non come false.

Esempio

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

Sorgente

Platform/groups.lua, riga 20. Nel gioco è in sola lettura; Duplica crea una copia modificabile.

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

Torna a Riferimento delle funzioni