Référence › Référence des fonctions › Platform

Platform.zone_pvp.GetZonePVPObservation

publique

Appel

addon.Platform:GetZonePVPObservation()

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

Ce qu'elle fait

Observe le premier résultat de classification JcJ de la zone avec un unique appel protégé avec point, sans argument. Préfère C_PvP.GetZonePVPInfo s'il est appelable et n'utilise la fonction globale que si l'appel moderne est absent. Un nil réussi ou une absence de valeurs renvoyées produit un enregistrement vide connu ; les observations manquantes, en échec, restreintes ou mal formées restent indisponibles. Les chaînes vides et futures lisibles conservent leur sens exact, et les champs renvoyés inutilisés ne déterminent pas la disponibilité. Ne change jamais d'implémentation après un résultat ou un échec de l'appel moderne.

Arguments

NomTypeCe qu'elle fait
selfRMPlatformAdaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).

Retours

1table | nilEnregistrement d'observation réussie avec une chaîne pvpType ou nil ; un enregistrement nil signifie « indisponible ».
2string | nilMotif de politique client, de capacité, d'appel ou de disponibilité de l'observation pour un enregistrement 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 jeuClassic EraTBC AnniversaryClassic ProgressionForeverRetail
C_PvPClassic EraTBC AnniversaryClassic ProgressionForeverRetail
GetZonePVPInfoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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

Source

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

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}

Retour à Référence des fonctions