Referencia › Referencia de funciones › Platform

Platform.instance.GetInstanceObservation

pública

Llamar como

addon.Platform:GetInstanceObservation()

Disponible directamente a través de addon; no se necesita ninguna dependencia.

Qué hace

Observa una única tupla protegida de IsInInstance sin argumentos. La pertenencia booleana legible necesaria es independiente del campo de tipo: si se sabe que está fuera, devuelve sin interpretar el tipo no usado; dentro, devuelve un tipo de cadena legible o un instanceTypeReason cuando ese campo secundario no está disponible. Quien compruebe que está fuera solo necesita la pertenencia; las comparaciones de tipo dentro deben comprobar el motivo secundario. No se agrega deducción de exterior, zona ni unidad.

Argumentos

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

Retornos

1table | nilRegistro con inInstance y, si está dentro, instanceType o instanceTypeReason; nil si la pertenencia no está disponible.
2string | nilMotivo de disponibilidad de la política del cliente, la llamada nativa o la pertenencia necesaria 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 usa 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
IsInInstanceClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Valores secretos (Retail y Forever)

En Retail y Forever, el juego les entrega a los addons valores secretos. Esta función auxiliar verifica 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 record = addon.Platform:GetInstanceObservation()
if not record then return nil end
if not record.inInstance then return false end
if not record.instanceType then return nil end
return record.instanceType == "raid"

Código fuente

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

Platform.instance.GetInstanceObservation(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
    if type(IsInInstance)~='function' then return nil,'missing-api' end
    local ok,inInstance,instanceType=pcall(IsInInstance)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(inInstance) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(inInstance) then return nil,'restricted-value' end
    if inInstance==nil then return nil,'instance-data-unavailable' end
    if type(inInstance)~='boolean' then return nil,'invalid-api-result' end
    if not inInstance then return {inInstance=false} end
    if not self:CanReadValue(instanceType) then return {inInstance=true,instanceTypeReason='restricted-value'} end
    if canaccessvalue and not canaccessvalue(instanceType) then return {inInstance=true,instanceTypeReason='restricted-value'} end
    if instanceType==nil then return {inInstance=true,instanceTypeReason='instance-type-unavailable'} end
    if type(instanceType)~='string' then return {inInstance=true,instanceTypeReason='invalid-api-result'} end
    return {inInstance=true,instanceType=instanceType}

Volver a Referencia de funciones