Platform.groups.GetUnitGroupMembership

Chiamala come

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Legge l'appartenenza di un'unità specificata al gruppo o all'incursione del giocatore. Con raidOnly true interroga solo UnitInRaid; altrimenti un risultato true di UnitInParty termina subito, false passa a UnitInRaid e un valore sconosciuto resta non disponibile. Un indice di incursione nil leggibile significa false; un indice intero da 1 a 40 significa true. I nomi vengono passati invariati alle API native; l'accettazione delle query per nome da parte delle API native richiede la qualificazione del client.

Argomenti

Nome	Tipo	Cosa fa
`self`	`RMPlatform`	Adattatore di piattaforma di Rotation Master (implicito nelle chiamate con due punti).
`unit`	`string`	Identificativo unità leggibile e non vuoto o nome riconosciuto dal client, passato invariato.
`raidOnly`	`boolean \| nil`	True controlla solo l'appartenenza all'incursione; false o nil controlla il gruppo e poi l'incursione.

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
`UnitInParty`
`UnitInRaid`
`canaccessvalue`

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 member = addon.Platform:GetUnitGroupMembership("focus", false)
if member == nil then return nil end
return member

Sorgente

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

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

Torna a Riferimento delle funzioni