Referência › Referência de funções › Platform

Platform.pet.GetPetObservation

pública

Chame como

addon.Platform:GetPetObservation(includeName)

Disponível diretamente por meio de addon; nenhuma dependência é necessária.

O que faz

Observa a existência exata do ajudante e, opcionalmente, o nome de exibição formatado de GetUnitName. Consultas apenas de presença nunca exigem dados de nome. Ausência conhecida pula a consulta do nome. Ajudantes presentes exigem um nome legível não vazio apenas quando solicitado; observações necessárias ausentes, com falha, nil, restritas ou malformadas retornam nil com um motivo. A função auxiliar de exibição é chamada com o único argumento original de ajudante, sem alternativa com UnitName nem estado deduzido de barra, vida ou habilidades.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
includeNameboolean | nilTrue solicita o nome formatado do ajudante; false ou omitido lê apenas a presença.

Retornos

1table | nilObservação do ajudante com exists booleano e, para um ajudante presente solicitado, name; nil quando dados necessários estão indisponíveis.
2string | nilMotivo de política, validação da consulta ou disponibilidade para uma observação de ajudante nil.

Edições

As funções auxiliares integradas são registradas em todas as edições. O que muda é a API do jogo que elas leem; quando uma está ausente, a função auxiliar recorre a uma alternativa ou retorna nil com um motivo.

  • Indisponível nessa edição (o motivo está na dica)
  • Só enquanto as alternativas da Blizzard para APIs obsoletas estiverem ativas
API do jogoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
GetUnitNameClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Valores secretos (Retail e Forever)

No Retail e no Forever, o jogo entrega valores secretos aos addons. Esta função auxiliar verifica o que lê (addon.Platform:CanReadValue) e retorna nil com um motivo como restricted-value em vez de um valor secreto que não consegue comparar. Trate nil como indisponível, não como false.

Exemplo

local pet = addon.Platform:GetPetObservation(false)
if not pet then return nil end
return not pet.exists -- time to summon

Código-fonte

Platform/pet.lua, linha 19. Somente leitura no jogo; Duplicar cria uma cópia editável.

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

Voltar para Referência de funções