Riferimento › Riferimento delle funzioni › Platform

Platform.instance.GetInstanceObservation

pubblica

Chiamala come

addon.Platform:GetInstanceObservation()

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Osserva una singola tupla protetta di IsInInstance senza argomenti. L'appartenenza booleana leggibile richiesta è indipendente dal campo del tipo: se accertato fuori, restituisce senza interpretare il tipo inutilizzato; se dentro, restituisce un tipo stringa leggibile oppure instanceTypeReason quando quel campo secondario non è disponibile. Chi verifica l'essere fuori ha bisogno solo dell'appartenenza; i confronti sul tipo all'interno devono controllare il motivo secondario. Non vengono aggiunte deduzioni su all'aperto, zona o unità.

Argomenti

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

Valori restituiti

1table | nilRecord con inInstance e, se all'interno, instanceType o instanceTypeReason; nil quando l'appartenenza non è disponibile.
2string | nilMotivo di policy del client, di chiamata nativa o di indisponibilità dell'appartenenza richiesta 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
IsInInstanceClassic 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 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"

Sorgente

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

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}

Torna a Riferimento delle funzioni