Referenz › Funktionsreferenz › Platform

Platform.zone_pvp.GetZonePVPObservation

öffentlich

Aufruf als

addon.Platform:GetZonePVPObservation()

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

Was sie bewirkt

Das erste Ergebnis der PvP-Klassifizierung der Zone mit einem geschützten Punktaufruf ohne Argumente beobachten. Das aufrufbare C_PvP.GetZonePVPInfo bevorzugen und die globale Hilfsfunktion nur verwenden, wenn die moderne fehlt. Ein erfolgreiches nil oder fehlende Rückgabewerte ergeben einen bekannten leeren Datensatz; fehlende, fehlgeschlagene, eingeschränkte oder fehlerhafte Beobachtungen bleiben nicht verfügbar. Lesbare leere und künftige Zeichenketten behalten ihre exakte Bedeutung, und ungenutzte Rückgabefelder bestimmen nicht die Verfügbarkeit. Nach einem modernen Ergebnis oder Fehlschlag nie das Backend wechseln.

Argumente

NameTypWas sie bewirkt
selfRMPlatformPlattformadapter von Rotation Master (bei Doppelpunktaufrufen implizit).

Rückgabewerte

1table | nilErfolgreicher Beobachtungsdatensatz mit pvpType als Zeichenkette oder nil; ein nil-Datensatz bedeutet „nicht verfügbar“.
2string | nilVerfügbarkeitsgrund aus Client-Richtlinie, Client-Unterstützung, Aufruf oder Beobachtung für einen nil-Datensatz.

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-APIClassic EraTBC AnniversaryClassic ProgressionForeverRetail
C_PvPClassic EraTBC AnniversaryClassic ProgressionForeverRetail
GetZonePVPInfoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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 zone = addon.Platform:GetZonePVPObservation()
if not zone then return nil end
return zone.pvpType == "sanctuary"

Quelle

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

Platform.zone_pvp.GetZonePVPObservation(self)
    local family=self:GetClientFamily()
    if family~='retail' and family~='forever' and family~='era' and family~='tbc' and family~='progression' then return nil,'unsupported-policy' end
    local namespace=C_PvP
    if not self:CanReadValue(namespace) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(namespace) then return nil,'restricted-value' end
    local api
    if type(namespace)=='table' then api=namespace.GetZonePVPInfo end
    if not self:CanReadValue(api) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(api) then return nil,'restricted-value' end
    if type(api)~='function' then
        api=GetZonePVPInfo
        if not self:CanReadValue(api) then return nil,'restricted-value' end
        if canaccessvalue and not canaccessvalue(api) then return nil,'restricted-value' end
        if type(api)~='function' then return nil,'missing-api' end
    end
    local ok,pvpType=pcall(api)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(pvpType) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(pvpType) then return nil,'restricted-value' end
    if pvpType==nil then return {} end
    if type(pvpType)~='string' then return nil,'invalid-api-result' end
    return {pvpType=pvpType}

Zurück zu Funktionsreferenz