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

Platform.unit_flags.GetUnitFlagObservation

pública

Chame como

addon.Platform:GetUnitFlagObservation(unit, kind)

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

O que faz

Observa um único indicador atual da unidade: combat usa UnitAffectingCombat, enemy usa UnitIsEnemy com player como primeira unidade e pvp usa UnitIsPVP. Uma unidade ausente legível retorna false sem consultar o indicador. Observações necessárias ausentes, com falha, restritas ou malformadas retornam nil com um motivo. Isso preserva a unidade selecionada exata e não deduz amizade, possibilidade de ataque nem outros estados da unidade.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
unitstringToken de unidade exato cujo indicador selecionado deve ser observado.
kindstringUm de combat, enemy ou pvp; outros tipos de indicadores não são suportados.

Retornos

1boolean | nilIndicador selecionado legível, false para unidade sabidamente ausente ou nil quando uma observação necessária está indisponível.
2string | nilMotivo de política, validação da consulta ou disponibilidade para um indicador de unidade 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
UnitAffectingCombatClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsEnemyClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsPVPClassic 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 inCombat = addon.Platform:GetUnitFlagObservation("target", "combat")
local enemy = addon.Platform:GetUnitFlagObservation("target", "enemy")
if inCombat == nil or enemy == nil then return nil end
return enemy and not inCombat

Dependências

Código-fonte

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

Platform.unit_flags.GetUnitFlagObservation(self, unit, kind)
    local policy=readClientPolicy(self)
    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~='combat' and kind~='enemy' and kind~='pvp' then return nil,'invalid-unit-flag-query' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local existsOk,exists=pcall(UnitExists,unit)
    if not existsOk 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
    if not exists then return false end
    local api
    if kind=='combat' then api=UnitAffectingCombat
    elseif kind=='enemy' then api=UnitIsEnemy
    else api=UnitIsPVP end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='enemy' 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-flag-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

Voltar para Referência de funções