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

Platform.unit_presence.GetUnitPresenceObservation

pública

Chame como

addon.Platform:GetUnitPresenceObservation(unit)

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

O que faz

Observa a presença da unidade em famílias de cliente identificadas. Passa a unidade selecionada sem alteração para uma única chamada protegida a UnitExists. Preserva os valores legíveis true e false; observações necessárias ausentes, com falha, restritas, nil ou malformadas retornam nil com um motivo. Nenhuma consulta de identidade, visibilidade, alcance ou estado de combate é adicionada.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
unitstringToken de unidade legível e não vazio, passado sem alteração como único argumento nativo.

Retornos

1boolean | nilPresença ou ausência conhecida da unidade; nil quando a observação necessária está indisponível.
2string | nilMotivo de disponibilidade da família de cliente, da validação da consulta ou de uma observação necessária para um resultado 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
UnitExistsClassic 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 present = addon.Platform:GetUnitPresenceObservation("focus")
if present == nil then return nil end
return not present

Código-fonte

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

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

Voltar para Referência de funções