Platform.groups.GetUnitGroupMembership

Aufruf als

addon.Platform:GetUnitGroupMembership(unit, raidOnly)

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

Was sie bewirkt

Die Zugehörigkeit einer angegebenen Einheit zur Gruppe oder zum Schlachtzug des Spielers lesen. raidOnly true fragt nur UnitInRaid ab; andernfalls beendet ein Ergebnis true von UnitInParty die Prüfung sofort, false geht weiter zu UnitInRaid, und unbekannt bleibt nicht verfügbar. Ein lesbarer nil-Schlachtzugsindex bedeutet false; ein ganzzahliger Schlachtzugsindex 1..40 bedeutet true. Namen werden unverändert an native APIs übergeben; ob native Namensabfragen akzeptiert werden, muss je Client bestätigt werden.

Argumente

Name	Typ	Was sie bewirkt
`self`	`RMPlatform`	Plattformadapter von Rotation Master (bei Doppelpunktaufrufen implizit).
`unit`	`string`	Lesbare nichtleere Einheitenkennung oder nativ erkannter Name, unverändert übergeben.
`raidOnly`	`boolean \| nil`	True prüft nur die Schlachtzugszugehörigkeit; false oder nil prüft erst Gruppe, dann Schlachtzug.

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

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

Quelle

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

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

Zurück zu Funktionsreferenz