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

Functions.forecast.finite

зависимость

Как вызывать

Functions.forecast.finite(platform, value)

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

Что делает

Checks that a number used by Functions.forecast.calculate is readable and finite.

Аргументы

ИмяТипЧто делает
platformRMPlatformPlatform whose CanReadValue decides readability.
valueanyValue to check.

Возвращает

1booleanTrue when the value is a readable finite number.
2string | nilWhen false: restricted-value or invalid-forecast-number.

Издания

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

Не читает игровой API напрямую.

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

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

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

Исходный код

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

Functions.forecast.finite(platform, value)
    if not platform:CanReadValue(value) then return false,'restricted-value' end
    if type(value)~='number' or value~=value or value>=math.huge or value<=-math.huge then return false,'invalid-forecast-number' end
    return true

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