Platform.groups.GetUnitGroupMembership

Appel

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

Disponible directement via addon ; aucune dépendance n'est nécessaire.

Ce qu'elle fait

Lit l'appartenance d'une unité donnée au groupe ou au raid du joueur. Avec raidOnly à true, seul UnitInRaid est interrogé ; sinon, un résultat true de UnitInParty court-circuite, false passe à UnitInRaid, et un résultat inconnu reste indisponible. Un indice de raid nil lisible signifie false ; un indice de raid entier de 1 à 40 signifie true. Les noms sont passés tels quels aux API natives ; l'acceptation des requêtes par nom par l'API native nécessite une qualification du client.

Arguments

Nom	Type	Ce qu'elle fait
`self`	`RMPlatform`	Adaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
`unit`	`string`	Identifiant d'unité lisible et non vide, ou nom reconnu nativement, passé tel quel.
`raidOnly`	`boolean \| nil`	true vérifie uniquement l'appartenance à un raid ; false ou nil vérifie le groupe, puis le raid.

Retours

1	`boolean \| nil`	Appartenance observée, ou nil si indisponible.
2	`string \| nil`	Motif de validation ou de disponibilité pour un résultat nil.

Éditions

Les fonctions utilitaires intégrées sont enregistrées sur toutes les éditions. Ce qui diffère, c'est l'API du jeu qu'elles lisent ; quand l'une manque, la fonction utilitaire se rabat sur une alternative ou renvoie nil avec une raison.

Indisponible sur cette édition (la raison figure dans l'infobulle)
Uniquement tant que les solutions de repli de Blizzard pour les fonctions obsolètes sont actives

API du jeu
`UnitInParty`
`UnitInRaid`
`canaccessvalue`

Valeurs secrètes (Retail et Forever)

Sur Retail et Forever, le jeu transmet aux addons des valeurs secrètes. Cette fonction utilitaire vérifie ce qu'elle lit (addon.Platform:CanReadValue) et renvoie nil avec une raison telle que restricted-value au lieu d'une valeur secrète qu'elle ne peut pas comparer. Traitez nil comme indisponible, pas comme false.

Exemple

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

Source

Platform/groups.lua, ligne 45. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

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

Retour à Référence des fonctions