Platform.pet.GetPetObservation

Chiamala come

addon.Platform:GetPetObservation(includeName)

Disponibile direttamente tramite addon; non serve alcuna dipendenza.

Cosa fa

Osserva l'esistenza esatta del famiglio e, facoltativamente, il suo nome visualizzato formattato da GetUnitName. Le query di sola presenza non richiedono mai il nome. Un'assenza accertata salta la query del nome. I famigli presenti richiedono un nome leggibile e non vuoto solo se richiesto; osservazioni richieste mancanti, fallite, nil, soggette a restrizioni o malformate restituiscono nil con un motivo. La funzione di visualizzazione viene chiamata con il suo unico argomento originale pet, senza ripiegare su UnitName e senza dedurre barra, salute o stato delle abilità.

Argomenti

Nome	Tipo	Cosa fa
`self`	`RMPlatform`	Adattatore di piattaforma di Rotation Master (implicito nelle chiamate con due punti).
`includeName`	`boolean \| nil`	True richiede il nome formattato del famiglio; false o omesso legge solo la presenza.

Valori restituiti

1	`table \| nil`	Osservazione del famiglio con exists booleano e, per un famiglio presente richiesto, name; nil quando i dati richiesti non sono disponibili.
2	`string \| nil`	Motivo di policy, di convalida della query o di indisponibilità quando l'osservazione del famiglio è 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 gioco
`GetUnitName`
`UnitExists`
`canaccessvalue`

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 pet = addon.Platform:GetPetObservation(false)
if not pet then return nil end
return not pet.exists -- time to summon

Sorgente

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

Platform.pet.GetPetObservation(self, includeName)

    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(includeName) then return nil,'restricted-value' end
    if includeName~=nil and type(includeName)~='boolean' then return nil,'invalid-pet-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,'pet')
    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,'pet-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local record={exists=exists}
    if not exists or not includeName then return record end
    if type(GetUnitName)~='function' then return nil,'missing-api' end
    local nameOk,name=pcall(GetUnitName,'pet')
    if not nameOk then return nil,'api-error' end
    if not self:CanReadValue(name) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(name) then return nil,'restricted-value' end
    if name==nil then return nil,'pet-name-unavailable' end
    if type(name)~='string' or name=='' then return nil,'invalid-api-result' end
    record.name=name
    return record

Torna a Riferimento delle funzioni