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

Platform.unit_metadata.GetUnitMetadataObservation

pública

Chame como

addon.Platform:GetUnitMetadataObservation(unit, kind)

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

O que faz

Observa um único campo de metadados nativos da unidade após verificar UnitExists: class usa o segundo retorno de UnitClass, creature usa o nome localizado de UnitCreatureType e classification usa UnitClassification. Uma unidade ausente legível retorna false sem consultar os metadados. Campos da tupla não usados não afetam a disponibilidade; um valor necessário ausente, com falha, nil, restrito ou malformado retorna nil com um motivo. Nenhuma dedução de classe do jogador, GUID, enum ou tradução é adicionada.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
unitstringToken de unidade exato cuja existência é verificada e que é passado à API de metadados selecionada.
kindstringUm de class, creature ou classification; outros tipos de metadados não são suportados.

Retornos

1string | boolean | nilTexto de metadados consumido legível, false para unidade sabidamente ausente ou 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 metadados 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
UnitClassClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitClassificationClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitCreatureTypeClassic 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 classification = addon.Platform:GetUnitMetadataObservation("target", "classification")
if classification == nil then return nil end
return classification == "worldboss" or classification == "elite"

Código-fonte

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

Platform.unit_metadata.GetUnitMetadataObservation(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~='class' and kind~='creature' and kind~='classification' then return nil,'invalid-unit-metadata-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=='class' then api=UnitClass
    elseif kind=='creature' then api=UnitCreatureType
    else api=UnitClassification end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,observed
    if kind=='class' then ok,observed=pcall(function() return select(2,api(unit)) end)
    else ok,observed=pcall(api,unit) end
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(observed) then return nil,'restricted-value' end
    if observed==nil then return nil,'unit-metadata-unavailable' end
    if type(observed)~='string' or observed=='' then return nil,'invalid-api-result' end
    return observed

Voltar para Referência de funções