Referencia › Referencia de funciones › Platform

Platform.zone_pvp.GetZonePVPObservation

pública

Llamar como

addon.Platform:GetZonePVPObservation()

Disponible directamente a través de addon; no hace falta ninguna dependencia.

Qué hace

Observa el primer resultado de clasificación JcJ de la zona con una única llamada con punto protegida y sin argumentos. Prefiere la función invocable C_PvP.GetZonePVPInfo y usa la función global solo cuando no existe la moderna. Un nil correcto o la ausencia de valores devueltos produce un registro vacío conocido; las observaciones que faltan, fallan, están restringidas o mal formadas siguen sin estar disponibles. Las cadenas legibles vacías y futuras conservan su significado exacto, y los campos de retorno no usados no determinan la disponibilidad. Nunca cambia de backend tras un resultado o un fallo de la moderna.

Argumentos

NombreTipoQué hace
selfRMPlatformAdaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).

Retornos

1table | nilRegistro de observación correcta con la cadena pvpType o nil; un registro nil significa no disponible.
2string | nilMotivo de disponibilidad de la política del cliente, la capacidad, la llamada o la observación para un registro nil.

Ediciones

Las funciones auxiliares integradas se registran en todas las ediciones. Lo que cambia es la API del juego que leen; donde falta alguna, la función auxiliar recurre a una alternativa o devuelve nil con un motivo.

  • No disponible en esa edición (el motivo aparece en la información emergente)
  • Solo mientras estén activas las alternativas de Blizzard para API obsoletas
API del juegoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
C_PvPClassic EraTBC AnniversaryClassic ProgressionForeverRetail
GetZonePVPInfoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Valores secretos (Retail y Forever)

En Retail y Forever, el juego entrega a los addons valores secretos. Esta función auxiliar comprueba lo que lee (addon.Platform:CanReadValue) y, en lugar de un secreto que no puede comparar, devuelve nil con un motivo como restricted-value. Trata nil como no disponible, no como falso.

Ejemplo

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

Código fuente

Platform/zone_pvp.lua, línea 18. Solo lectura en el juego; Duplicar crea una copia editable.

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}

Volver a Referencia de funciones