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

Platform.unit_presence.GetUnitPresenceObservation

publique

Appel

addon.Platform:GetUnitPresenceObservation(unit)

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

Ce qu'elle fait

Observe la présence d'une unité sur les familles de clients identifiées. Passe l'unité sélectionnée telle quelle à un unique appel protégé à UnitExists. Conserve true et false lisibles ; les observations requises manquantes, en échec, restreintes, nil ou mal formées renvoient nil avec un motif. Aucune requête d'identité, de visibilité, de portée ou d'état de combat n'est ajoutée.

Arguments

NomTypeCe qu'elle fait
selfRMPlatformAdaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
unitstringIdentifiant d'unité lisible et non vide, passé tel quel comme argument natif unique.

Retours

1boolean | nilPrésence ou absence connue de l'unité ; nil si l'observation requise est indisponible.
2string | nilMotif de famille de client, de validation de la requête ou de disponibilité d'une observation requise pour un résultat 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 jeuClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitExistsClassic 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 present = addon.Platform:GetUnitPresenceObservation("focus")
if present == nil then return nil end
return not present

Source

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

Platform.unit_presence.GetUnitPresenceObservation(self, unit)
    if not self:CanReadValue(unit) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if self:GetClientFamily()=='unknown' then return nil,'unsupported-client' end
    if type(UnitExists)~='function' then return nil,'missing-api' end
    local ok,exists=pcall(UnitExists,unit)
    if not ok 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
    return exists

Retour à Référence des fonctions