Platform.unit_flags.GetUnitFlagObservation

Appel

addon.Platform:GetUnitFlagObservation(unit, kind)

Disponible directement via addon ; aucune dépendance n'est nécessaire.

Ce qu'elle fait

Observe un seul indicateur d'unité actuel : combat utilise UnitAffectingCombat, enemy utilise UnitIsEnemy avec player comme première unité, et pvp utilise UnitIsPVP. Une unité absente lisible renvoie false sans interroger l'indicateur. Les observations requises manquantes, en échec, restreintes ou mal formées renvoient nil avec un motif. L'unité sélectionnée exacte est conservée, sans déduire le caractère amical, attaquable ou tout autre état de l'unité.

Arguments

Nom	Type	Ce qu'elle fait
`self`	`RMPlatform`	Adaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
`unit`	`string`	Identifiant d'unité exact dont l'indicateur sélectionné doit être observé.
`kind`	`string`	combat, enemy ou pvp ; les autres types d'indicateurs ne sont pas pris en charge.

Retours

1	`boolean \| nil`	Indicateur sélectionné lisible, false pour une unité connue comme absente, ou nil si une observation requise est indisponible.
2	`string \| nil`	Motif de politique, de validation de la requête ou de disponibilité pour un indicateur d'unité nil.

Éditions

Les fonctions utilitaires intégrées sont enregistrées sur toutes les éditions. Ce qui diffère, c'est l'API du jeu qu'elles lisent ; quand l'une manque, la fonction utilitaire se rabat sur une alternative ou renvoie nil avec une raison.

Indisponible sur cette édition (la raison figure dans l'infobulle)
Uniquement tant que les solutions de repli de Blizzard pour les fonctions obsolètes sont actives

API du jeu
`UnitAffectingCombat`
`UnitExists`
`UnitIsEnemy`
`UnitIsPVP`

Valeurs secrètes (Retail et Forever)

Sur Retail et Forever, le jeu transmet aux addons des valeurs secrètes. Cette fonction utilitaire vérifie ce qu'elle lit (addon.Platform:CanReadValue) et renvoie nil avec une raison telle que restricted-value au lieu d'une valeur secrète qu'elle ne peut pas comparer. Traitez nil comme indisponible, pas comme false.

Exemple

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

Dépendances

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

Source

Platform/unit_flags.lua, ligne 39. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

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

Retour à Référence des fonctions