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

Platform.points.GetUnitPointPowerObservation

publique

Appel

addon.Platform:GetUnitPointPowerObservation(unit, powerType, kind)

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

Ce qu'elle fait

Lit une quantité de ressource à points explicitement sélectionnée avec une requête exacte à deux arguments UnitPower ou UnitPowerMax. Le sélecteur est requis ; aucune déduction de ressource principale ni réaffectation d'acteur n'a lieu. Conserve les quantités finies signées, fractionnaires et nulles, sans bornage. Les données manquantes, en échec, restreintes ou non finies restent indisponibles. Current et maximum sont des observations distinctes, afin que les appelants puissent partager les instantanés de valeur actuelle tout en demandant le maximum de façon paresseuse.

Arguments

NomTypeCe qu'elle fait
selfRMPlatformAdaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
unitstringIdentifiant d'unité exact dont la quantité de ressource sélectionnée est demandée.
powerTypenumberSélecteur de ressource explicite, lisible, fini et entier non négatif, zéro compris.
kindstringExactement current pour UnitPower ou maximum pour UnitPowerMax ; aucune autre requête native n'est ajoutée.

Retours

1number | nilQuantité de ressource native finie, avec son signe et sa partie fractionnaire ; nil si indisponible.
2string | nilMotif de politique, de validation de la requête ou de disponibilité pour une quantité 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
UnitPowerClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitPowerMaxClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic 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 holyPower = addon.Platform:GetUnitPointPowerObservation("player", Enum.PowerType.HolyPower, "current")
if holyPower == nil then return nil end
return holyPower >= 3

Dépendances

Source

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

Platform.points.GetUnitPointPowerObservation(self, unit, powerType, kind)
    local policy=self:GetCombatDataPolicy()
    if policy~='probe' and (policy~='restricted' or not self:IsNeverSecretPointPower(powerType)) then return nil,'unsupported-policy' end
    if not self:CanReadValue(unit) or not self:CanReadValue(powerType) or not self:CanReadValue(kind) then return nil,'restricted-value' end
    if type(unit)~='string' or unit=='' then return nil,'invalid-unit' end
    if type(powerType)~='number' or powerType~=powerType or powerType<0 or powerType==math.huge or powerType%1~=0 then return nil,'invalid-point-power-query' end
    if kind~='current' and kind~='maximum' then return nil,'invalid-point-power-query' end
    if powerType==pointFragmentType then return self:GetUnitPointFragmentObservation(unit,powerType,kind) end
    local api
    if kind=='current' then api=UnitPower else api=UnitPowerMax end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,result=pcall(api,unit,powerType)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(result) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(result) then return nil,'restricted-value' end
    if result==nil then return nil,'point-power-unavailable' end
    if type(result)~='number' or result~=result or result==math.huge or result==-math.huge then return nil,'invalid-api-result' end
    return result

Retour à Référence des fonctions