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

Platform.unit_states.GetUnitStateObservation

pública

Chame como

addon.Platform:GetUnitStateObservation(unit, kind)

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

O que faz

Observa o estado de morte ou fantasma, ou a amizade com o jogador, da unidade selecionada exata em clientes com política de sondagem ou restrita. Uma observação necessária ausente, com falha, restrita ou malformada fica indisponível. A ausência da unidade fica indisponível, em vez de ser uma correspondência negativa, inclusive sob NÃO. Nenhum estado é mantido entre consultas.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
unitstringToken de unidade exato e não vazio a observar.
kindstringExatamente dead para UnitIsDeadOrGhost, ou friendly para UnitIsFriend(player, unit).

Retornos

1boolean | nilEstado atual legível, ou nil quando indisponível.
2string | nilMotivo de disponibilidade ou de validação da consulta quando nenhum estado atual pode ser lido.

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
UnitIsDeadOrGhostClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsFriendClassic 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 friendly = addon.Platform:GetUnitStateObservation("target", "friendly")
local dead = addon.Platform:GetUnitStateObservation("target", "dead")
if friendly == nil or dead == nil then return nil end
return friendly and dead -- a friend to resurrect

Código-fonte

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

Platform.unit_states.GetUnitStateObservation(self, unit, kind)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if kind~='dead' and kind~='friendly' then return nil,'invalid-unit-state-query' end
    local existsAPI=UnitExists
    if type(existsAPI)~='function' then return nil,'missing-api' end
    local existsOK,exists=pcall(existsAPI,unit)
    if not existsOK then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil or exists==false then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local api
    if kind=='dead' then api=UnitIsDeadOrGhost else api=UnitIsFriend end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='friendly' then ok,result=pcall(api,'player',unit)
    else ok,result=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'unit-state-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

Voltar para Referência de funções