Platform.groups.GetGroupMembership

Aufruf als

addon.Platform:GetGroupMembership(raidOnly)

Direkt über addon verfügbar; keine Abhängigkeit nötig.

Was sie bewirkt

Öffentliche Gruppenzugehörigkeit auf identifizierten Client-Familien lesen. Unbekannte Clients werden nicht unterstützt. raidOnly true prüft IsInRaid; false oder nil prüft IsInGroup mit dessen nativer Standard-Gruppenkategorie. Ein lesbares Ergebnis false bleibt false. Fehlende, fehlgeschlagene, fehlerhafte oder eingeschränkte Beobachtungen ergeben nil mit einem Grund.

Argumente

Name	Typ	Was sie bewirkt
`self`	`RMPlatform`	Plattformadapter von Rotation Master (bei Doppelpunktaufrufen implizit).
`raidOnly`	`boolean \| nil`	True fragt die Schlachtzugszugehörigkeit ab; false oder nil fragt eine beliebige Gruppenzugehörigkeit ab.

Rückgabewerte

1	`boolean \| nil`	Beobachtete Zugehörigkeit oder nil, wenn nicht verfügbar.
2	`string \| nil`	Validierungs- oder Verfügbarkeitsgrund für ein nil-Ergebnis.

Editionen

Integrierte Hilfsfunktionen werden auf jeder Edition registriert. Unterschiedlich ist die Spiel-API, die sie lesen; fehlt eine, weicht die Hilfsfunktion aus oder gibt nil mit einem Grund zurück.

Auf dieser Edition nicht verfügbar (den Grund nennt der Tooltip)
Nur, solange Blizzards Ersatz für veraltete Funktionen aktiv ist

Spiel-API
`IsInGroup`
`IsInRaid`

Geheime Werte (Retail und Forever)

Auf Retail und Forever übergibt das Spiel Addons geheime Werte. Diese Hilfsfunktion prüft, was sie liest (addon.Platform:CanReadValue), und gibt statt eines geheimen Werts, den sie nicht vergleichen kann, nil mit einem Grund wie restricted-value zurück. Behandeln Sie nil als nicht verfügbar, nicht als false.

Beispiel

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

Quelle

Platform/groups.lua, Zeile 20. Im Spiel schreibgeschützt; Duplizieren erstellt eine bearbeitbare Kopie.

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

Zurück zu Funktionsreferenz