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

Platform.health_forecast.providerValue

зависимость

Как вызывать

Platform.health_forecast.providerValue(self, value)

Запишите зависимость Platform.health_forecast.providerValue и вызывайте её по этому имени. Вызов через пространство имён не передаёт self: используйте вызов через двоеточие или передайте объект сами.

Что делает

Normalizes one health figure returned by the RealMobHealth provider. Returns the value when it is a readable finite nonnegative number, nil with no reason when it is nil or false (the provider has no figure, so native health can be used instead), or nil with "restricted-value" or "invalid-api-result".

Аргументы

ИмяТипЧто делает
selfRMPlatformRotation Master platform adapter (normally addon.Platform), used for its CanReadValue check.
valueanyCurrent or maximum health value from RealMobHealth.GetUnitHealth.

Возвращает

1number | nilFinite nonnegative health value, or nil when absent or unavailable.
2string | nilReason when the value is unusable; nil when it is valid or simply absent.

Издания

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

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

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

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

Как его вызывает аддон

Зависимости

Исходный код

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

Platform.health_forecast.providerValue(self, value)
    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 or value==false then return nil end
    if not finite(value) or value<0 then return nil,'invalid-api-result' end
    return value

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