Référence › Référence des fonctions › Platform

Platform.unit_states.GetUnitStateObservation

publique

Appel

addon.Platform:GetUnitStateObservation(unit, kind)

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

Ce qu'elle fait

Observe l'état mort ou fantôme, ou le caractère amical envers le joueur, de l'unité sélectionnée exacte sur les clients en politique de sondage ou restreinte. Une observation requise manquante, en échec, restreinte ou mal formée est indisponible. L'absence de l'unité est indisponible plutôt qu'une correspondance négative, y compris sous NOT. Aucun état n'est conservé d'une interrogation à l'autre.

Arguments

NomTypeCe qu'elle fait
selfRMPlatformAdaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
unitstringIdentifiant d'unité exact et non vide à observer.
kindstringExactement dead pour UnitIsDeadOrGhost, ou friendly pour UnitIsFriend(player, unit).

Retours

1boolean | nilÉtat actuel lisible, ou nil si indisponible.
2string | nilMotif de disponibilité ou de validation de la requête lorsqu'aucun état actuel ne peut être lu.

É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 jeuClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsDeadOrGhostClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitIsFriendClassic EraTBC AnniversaryClassic ProgressionForeverRetail

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 friendly = addon.Platform:GetUnitStateObservation("target", "friendly")
local dead = addon.Platform:GetUnitStateObservation("target", "dead")
if friendly == nil or dead == nil then return nil end
return friendly and dead -- a friend to resurrect

Source

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

Platform.unit_states.GetUnitStateObservation(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~='dead' and kind~='friendly' then return nil,'invalid-unit-state-query' end
    local existsAPI=UnitExists
    if type(existsAPI)~='function' then return nil,'missing-api' end
    local existsOK,exists=pcall(existsAPI,unit)
    if not existsOK then return nil,'api-error' end
    if not self:CanReadValue(exists) then return nil,'restricted-value' end
    if exists==nil or exists==false then return nil,'unit-data-unavailable' end
    if type(exists)~='boolean' then return nil,'invalid-api-result' end
    local api
    if kind=='dead' then api=UnitIsDeadOrGhost else api=UnitIsFriend end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result
    if kind=='friendly' 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-state-unavailable' end
    if type(result)~='boolean' then return nil,'invalid-api-result' end
    return result

Retour à Référence des fonctions