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

Platform.points.GetUnitPointPowerObservation

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

Как вызывать

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

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

Что делает

Прочитать одно явно выбранное количество очков ресурса точным запросом UnitPower или UnitPowerMax с двумя аргументами. Выбор обязателен; основной ресурс не выводится, участники не переназначаются. Конечные знаковые, дробные и нулевые количества сохраняются без усечения. Отсутствующие, неудачные, ограниченные или бесконечные данные остаются недоступными. Current и maximum — отдельные наблюдения, чтобы вызывающие могли делиться снимками текущего значения, запрашивая максимум лениво.

Аргументы

ИмяТипЧто делает
selfRMPlatformАдаптер платформы Rotation Master (неявно при вызове через двоеточие).
unitstringТочный токен юнита, для которого запрашивается выбранное количество ресурса.
powerTypenumberЯвный читаемый конечный неотрицательный целочисленный выбор ресурса, включая ноль.
kindstringРовно current для UnitPower или maximum для UnitPowerMax; других встроенных запросов не добавляется.

Возвращает

1number | nilКонечное встроенное количество ресурса с сохранением знака и дробной части; nil, если недоступно.
2string | nilПричина по политике, проверке запроса или недоступности для количества nil.

Издания

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

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

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

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

Пример

local holyPower = addon.Platform:GetUnitPointPowerObservation("player", Enum.PowerType.HolyPower, "current")
if holyPower == nil then return nil end
return holyPower >= 3

Зависимости

Исходный код

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

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

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