Functions.forecast.readField

呼叫方式

Functions.forecast.readField(platform, object, key)

記錄相依項目 Functions.forecast.readField，然後以該名稱呼叫。含命名空間的呼叫不會傳入 self：請使用冒號呼叫，或自行傳入該物件。

作用

Reads object[key] for Functions.forecast.calculate without letting a restricted value, a non-table object or an index error escape.

參數

名稱	類型	作用
`platform`	`RMPlatform`	Platform whose CanReadValue decides readability.
`object`	`any`	Table to read, such as the history record or one of its rows.
`key`	`any`	Key to read, such as "damage" or "time".

傳回值

1	`any`	The field's value (possibly nil), or nil on failure.
2	`string \| nil`	Reason on failure: restricted-value, invalid-forecast-history or forecast-history-error.

版本

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

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

機密值（正式版與永久）

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

插件如何呼叫它

Functions.forecast.calculate

local rows,why=readField(platform,history,name)

原始碼

Functions/forecast.lua，第 38 行。在遊戲中為唯讀；「複製」會產生一份可編輯的複本。

Functions.forecast.readField(platform, object, key)

    if not platform:CanReadValue(object) then return nil,'restricted-value' end
    if type(object)~='table' then return nil,'invalid-forecast-history' end
    local ok,value=pcall(function() return object[key] end)
    if not ok then return nil,'forecast-history-error' end
    if not platform:CanReadValue(value) then return nil,'restricted-value' end
    return value

返回函式參考