Riferimento › Riferimento delle funzioni › Platform

Platform.unit_presence.GetUnitPresenceObservation

pubblica

Chiamala come

addon.Platform:GetUnitPresenceObservation(unit)

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Osserva la presenza dell'unità sulle famiglie di client identificate. Passa l'unità selezionata invariata a un'unica chiamata protetta a UnitExists. Preserva true e false leggibili; osservazioni richieste mancanti, fallite, soggette a restrizioni, nil o malformate restituiscono nil con un motivo. Non vengono aggiunte query su identità, visibilità, distanza o stato di combattimento.

Argomenti

NomeTipoCosa fa
selfRMPlatformAdattatore di piattaforma di Rotation Master (implicito nelle chiamate con due punti).
unitstringIdentificativo unità leggibile e non vuoto, passato invariato come unico argomento nativo.

Valori restituiti

1boolean | nilPresenza o assenza nota dell'unità; nil quando l'osservazione richiesta non è disponibile.
2string | nilMotivo di famiglia del client, di convalida della query o di indisponibilità di un'osservazione richiesta quando il risultato è 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
UnitExistsClassic 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 present = addon.Platform:GetUnitPresenceObservation("focus")
if present == nil then return nil end
return not present

Sorgente

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

Platform.unit_presence.GetUnitPresenceObservation(self, unit)
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    return exists

Torna a Riferimento delle funzioni