Referencia › Referencia de funciones › Platform

Platform.unit_metadata.GetUnitMetadataObservation

pública

Llamar como

addon.Platform:GetUnitMetadataObservation(unit, kind)

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

Qué hace

Observa un único campo de metadatos nativos de la unidad tras comprobar UnitExists: class usa el segundo retorno de UnitClass, creature usa el nombre localizado de UnitCreatureType y classification usa UnitClassification. Una unidad ausente legible devuelve false sin consultar los metadatos. Los campos de la tupla no usados no afectan a la disponibilidad; un valor necesario que falta, falla, es nil, está restringido o mal formado devuelve nil con un motivo. No se agrega deducción de la clase del jugador, del GUID, de enums ni de traducciones.

Argumentos

NombreTipoQué hace
selfRMPlatformAdaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).
unitstringToken de unidad exacto cuya existencia se comprueba y que se pasa a la API de metadatos seleccionada.
kindstringUno de class, creature o classification; los demás tipos de metadatos no son compatibles.

Retornos

1string | boolean | nilCadena de metadatos consumida legible, false si se sabe que la unidad está ausente o nil cuando faltan datos necesarios.
2string | nilMotivo de política, validación de la consulta o disponibilidad para una observación de metadatos 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
UnitClassClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitClassificationClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitCreatureTypeClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic 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 classification = addon.Platform:GetUnitMetadataObservation("target", "classification")
if classification == nil then return nil end
return classification == "worldboss" or classification == "elite"

Código fuente

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

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

Volver a Referencia de funciones