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

Platform.creature_type.GetUnitCreatureTypeID

pública

Chame como

addon.Platform:GetUnitCreatureTypeID(unit)

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

O que faz

Observa a identidade da criatura a partir do segundo retorno nativo de UnitCreatureType em clientes com política de sondagem ou restrita. Verifica primeiro exatamente UnitExists(unit); um false legível retorna false sem exigir nem chamar metadados de criatura. Uma unidade presente exige um ID numérico finito legível; o nome localizado não usado não afeta a disponibilidade. Preserva IDs com sinal, fracionários, zero e futuros finitos como valores conhecidos. Dados necessários ausentes, com falha, nil, restritos ou malformados retornam nil com um motivo. Nenhuma enumeração de criaturas, comparação de legendas traduzidas ou cache de longo prazo é adicionada.

Argumentos

NomeTipoO que faz
selfRMPlatformAdaptador de plataforma do Rotation Master (implícito nas chamadas com dois-pontos).
unitstringToken de unidade selecionado, legível e não vazio, passado sem alteração como único argumento às consultas de existência e de metadados de criatura.

Retornos

1number | boolean | nilID de criatura nativo finito, false para ausência conhecida da unidade ou nil quando observações necessárias estão indisponíveis.
2string | nilMotivo de política, validação da consulta ou disponibilidade de observação necessária para um ID 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
UnitCreatureTypeClassic 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 id = addon.Platform:GetUnitCreatureTypeID("target")
if id == nil then return nil end
-- false (no target) never equals 6, the Undead creature type.
return id == 6

Código-fonte

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

Platform.creature_type.GetUnitCreatureTypeID(self, unit)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and policy~='restricted' then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' 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 native=UnitCreatureType
    if type(native)~='function' then return nil,'missing-api' end
    local observed,_,id=pcall(native,unit)
    if not observed then return nil,'api-error' end
    if not self:CanReadValue(id) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(id) then return nil,'restricted-value' end
    if id==nil then return nil,'unit-creature-type-unavailable' end
    if type(id)~='number' or id~=id or id==math.huge or id==-math.huge then return nil,'invalid-api-result' end
    return id

Voltar para Referência de funções