Riferimento › Riferimento delle funzioni › Platform

Platform.zone_pvp.GetZonePVPObservation

pubblica

Chiamala come

addon.Platform:GetZonePVPObservation()

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Osserva il primo risultato della classificazione PvP della zona con un'unica chiamata con punto protetta senza argomenti. Preferisci C_PvP.GetZonePVPInfo se richiamabile e usa la funzione globale solo quando quella moderna non è richiamabile. Un nil restituito con successo o l'assenza di valori restituiti produce un record vuoto noto; osservazioni mancanti, fallite, soggette a restrizioni o malformate restano non disponibili. Le stringhe vuote e future leggibili mantengono il loro significato esatto e i campi restituiti inutilizzati non determinano la disponibilità. Non cambiare mai backend dopo un risultato o un errore di quella moderna.

Argomenti

NomeTipoCosa fa
selfRMPlatformAdattatore di piattaforma di Rotation Master (implicito nelle chiamate con due punti).

Valori restituiti

1table | nilRecord di osservazione riuscita con stringa pvpType o nil; un record nil indica non disponibile.
2string | nilMotivo di policy del client, di funzionalità, di chiamata o di indisponibilità dell'osservazione quando il record è nil.

Edizioni

Le funzioni di supporto integrate sono registrate su ogni edizione. Ciò che cambia è l'API di gioco che leggono; dove ne manca una, la funzione di supporto ripiega su un'alternativa o restituisce nil con un motivo.

  • Non disponibile su quell'edizione (il motivo è nel suggerimento)
  • Solo mentre sono attivi i ripieghi di Blizzard per le API deprecate
API di giocoClassic EraTBC AnniversaryClassic progressionForeverRetail
C_PvPClassic EraTBC AnniversaryClassic progressionForeverRetail
GetZonePVPInfoClassic EraTBC AnniversaryClassic progressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic progressionForeverRetail

Valori segreti (Retail e Forever)

Su Retail e Forever il gioco fornisce agli addon valori segreti. Questa funzione di supporto controlla ciò che legge (addon.Platform:CanReadValue) e restituisce nil con un motivo come restricted-value invece di un valore segreto che non può confrontare. Considera nil come non disponibile, non come false.

Esempio

local zone = addon.Platform:GetZonePVPObservation()
if not zone then return nil end
return zone.pvpType == "sanctuary"

Sorgente

Platform/zone_pvp.lua, riga 18. Nel gioco è in sola lettura; Duplica crea una copia modificabile.

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}

Torna a Riferimento delle funzioni