Referencia › Referencia de funciones › Platform

Platform.creature_type.GetUnitCreatureTypeID

pública

Llamar como

addon.Platform:GetUnitCreatureTypeID(unit)

Disponible directamente a través de addon; no se necesita ninguna dependencia.

Qué hace

Observa la identidad de la criatura a partir del segundo retorno nativo de UnitCreatureType en clientes con política de sondeo o restringida. Comprueba primero exactamente UnitExists(unit); un false legible devuelve false sin requerir ni llamar a los metadatos de criatura. Una unidad presente requiere un ID numérico finito legible; el nombre localizado no usado no afecta a la disponibilidad. Conserva los ID con signo, fraccionarios, cero y futuros finitos como valores conocidos. Los datos necesarios que faltan, fallan, son nil, están restringidos o mal formados devuelven nil con un motivo. No se agrega enumeración de criaturas, comparación de textos traducidos ni caché a largo plazo.

Argumentos

NombreTipoQué hace
selfRMPlatformAdaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).
unitstringToken de unidad seleccionado, legible y no vacío, que se pasa sin cambios como único argumento a las consultas de existencia y de metadatos de criatura.

Retornos

1number | boolean | nilID de criatura nativo finito, false si se sabe que la unidad está ausente o nil cuando las observaciones necesarias no están disponibles.
2string | nilMotivo de política, validación de la consulta o disponibilidad de una observación necesaria para un ID nil.

Ediciones

Las funciones auxiliares integradas se registran en todas las ediciones. Lo que cambia es la API del juego que leen; donde falta alguna, la función auxiliar usa una alternativa o devuelve nil con un motivo.

  • No disponible en esa edición (el motivo aparece en la información emergente)
  • Solo mientras estén activas las alternativas de Blizzard para API obsoletas
API del juegoClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitCreatureTypeClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Valores secretos (Retail y Forever)

En Retail y Forever, el juego les entrega a los addons valores secretos. Esta función auxiliar verifica lo que lee (addon.Platform:CanReadValue) y, en lugar de un secreto que no puede comparar, devuelve nil con un motivo como restricted-value. Trata nil como no disponible, no como falso.

Ejemplo

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 fuente

Platform/creature_type.lua, línea 17. Solo lectura en el juego; Duplicar crea una copia editable.

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

Volver a Referencia de funciones