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.

參數

名稱	類型	作用
`platform`	`RMPlatform`	Platform whose CanReadValue decides readability.
`value`	`any`	Value to check.

傳回值

1	`boolean`	True when the value is a readable finite number.
2	`string \| nil`	When false: restricted-value or invalid-forecast-number.

版本

內建輔助函式在每個版本上都會註冊。不同的是它們讀取的遊戲 API；某個 API 不存在時，輔助函式會改用備用方式，或傳回 nil 並附上原因。

它不會直接讀取任何遊戲 API。

機密值（正式版與永久）

在正式版與永久上，遊戲交給插件的是機密值。此輔助函式會檢查它讀取的內容（addon.Platform:CanReadValue），遇到無法比較的機密值時，會傳回 nil 並附上原因（例如 restricted-value），而不是傳回該機密值。請將 nil 視為無法使用，而非假。

插件如何呼叫它

Functions.forecast.calculate

local valid,reason=finite(platform,window)

原始碼

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

返回函式參考