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

Platform.health_forecast.GetHealthForecastValueObservation

publique

Appel

addon.Platform:GetHealthForecastValueObservation(unit, kind)

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

Ce qu'elle fait

Lit une valeur scalaire de points de vie paresseuse après une vérification d'identité distincte. Le type current utilise exactement UnitHealth(unit) ; maximum utilise exactement UnitHealthMax(unit). Les clients en politique de sondage ou restreinte acceptent les nombres lisibles, finis et non négatifs, zéro compris. Aucun appel répété d'existence ou de GUID ni repli sur un autre tuple n'est ajouté.

Arguments

NomTypeCe qu'elle fait
selfRMPlatformAdaptateur de plateforme Rotation Master (implicite avec un appel par deux-points).
unitstringIdentifiant d'unité sélectionné non vide ; cet appel à lui seul n'établit pas la présence.
kindstringType scalaire fermé : current ou maximum.

Retours

1number | nilValeur scalaire de points de vie native, finie et non négative, ou nil si indisponible.
2string | nilMotif de politique, de validation ou de disponibilité d'une observation requise.

É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
UnitHealthClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitHealthMaxClassic 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 current = addon.Platform:GetHealthForecastValueObservation("target", "current")
local maximum = addon.Platform:GetHealthForecastValueObservation("target", "maximum")
if not current or not maximum or maximum == 0 then return nil end
return current / maximum <= 0.35

Dépendances

Source

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

Platform.health_forecast.GetHealthForecastValueObservation(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
    local api
    if kind=='current' then api=UnitHealth
    elseif kind=='maximum' then api=UnitHealthMax
    else return nil,'invalid-health-forecast-query' end
    if type(api)~='function' then return nil,'missing-api' end
    local ok,value=pcall(api,unit)
    if not ok then return nil,'api-error' end
    if not self:CanReadValue(value) then return nil,'restricted-value' end
    if canaccessvalue and not canaccessvalue(value) then return nil,'restricted-value' end
    if value==nil then return nil,'health-data-unavailable' end
    if not finite(value) or value<0 then return nil,'invalid-api-result' end
    return value

Retour à Référence des fonctions