Справочник › Справочник функций › Platform

Platform.health_forecast.GetHealthForecastValueObservation

общедоступный

Как вызывать

addon.Platform:GetHealthForecastValueObservation(unit, kind)

Доступен напрямую через addon; зависимость не нужна.

Что делает

Прочитать ленивое скалярное значение здоровья после отдельной проверки идентичности. Вид current использует точный UnitHealth(unit), maximum — точный UnitHealthMax(unit). Клиенты с политикой проверки или ограничения принимают читаемые конечные неотрицательные числа, включая ноль. Повторный вызов существования/GUID или запасной кортеж не добавляются.

Аргументы

ИмяТипЧто делает
selfRMPlatformАдаптер платформы Rotation Master (неявно при вызове через двоеточие).
unitstringВыбранный непустой токен юнита; один этот вызов не устанавливает присутствие.
kindstringЗакрытый вид скаляра: current или maximum.

Возвращает

1number | nilКонечное неотрицательное встроенное значение здоровья или nil, если недоступно.
2string | nilПричина по политике, проверке или недоступности обязательного наблюдения.

Издания

Встроенные помощники регистрируются во всех изданиях. Различается игровой API, который они читают; если нужного API нет, помощник использует запасной вариант или возвращает nil с причиной.

  • Недоступно в этом издании (причина — во всплывающей подсказке)
  • Только пока включены запасные реализации Blizzard для устаревших функций
Игровой APIClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitHealthClassic EraTBC AnniversaryClassic ProgressionForeverRetail
UnitHealthMaxClassic EraTBC AnniversaryClassic ProgressionForeverRetail
canaccessvalueClassic EraTBC AnniversaryClassic ProgressionForeverRetail

Секретные значения (Retail и Forever)

В Retail и Forever игра передаёт аддонам секретные значения. Этот помощник проверяет то, что читает (addon.Platform:CanReadValue), и вместо секретного значения, которое нельзя сравнить, возвращает nil с причиной, например restricted-value. Считайте nil недоступным значением, а не ложью.

Пример

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

Зависимости

Исходный код

Platform/health_forecast.lua, строка 81. В игре только для чтения; «Дублировать» создаёт редактируемую копию.

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

Назад: Справочник функций