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

返回函数参考