Platform.unit_flags.GetUnitFlagObservation

Llamar como

addon.Platform:GetUnitFlagObservation(unit, kind)

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

Qué hace

Observa un único indicador actual de la unidad: combat usa UnitAffectingCombat, enemy usa UnitIsEnemy con player como primera unidad y pvp usa UnitIsPVP. Una unidad ausente legible devuelve false sin consultar el indicador. Las observaciones necesarias que faltan, fallan, están restringidas o mal formadas devuelven nil con un motivo. Conserva la unidad seleccionada exacta y no deduce amistad, posibilidad de ataque ni otros estados de la unidad.

Argumentos

Nombre	Tipo	Qué hace
`self`	`RMPlatform`	Adaptador de plataforma de Rotation Master (implícito en las llamadas con dos puntos).
`unit`	`string`	Token de unidad exacto cuyo indicador seleccionado se debe observar.
`kind`	`string`	Uno de combat, enemy o pvp; los demás tipos de indicadores no son compatibles.

Retornos

1	`boolean \| nil`	Indicador seleccionado legible, false si se sabe que la unidad está ausente o nil cuando una observación necesaria no está disponible.
2	`string \| nil`	Motivo de política, validación de la consulta o disponibilidad para un indicador de unidad 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 juego
`UnitAffectingCombat`
`UnitExists`
`UnitIsEnemy`
`UnitIsPVP`

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 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

Dependencias

readClientPolicy (builtin:Platform/unit_flags.lua:readClientPolicy)

Código fuente

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

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

Volver a Referencia de funciones