参考 › 函数参考 › Core

Core.threat_count_conditions.readField

依赖项

调用方式

Core.threat_count_conditions.readField(platform, object, key)

记录依赖项 Core.threat_count_conditions.readField,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。

作用

Reads object[key] for the threat-count conditions without letting a restricted value, a non-table object or an index error escape.

参数

名称类型作用
platformRMPlatformPlatform whose CanReadValue decides readability.
objectanyTable to read, such as the addon or a unit snapshot entry.
keyanyKey to read, such as "unitsInRange".

返回值

1anyThe field's value (possibly nil), or nil on failure.
2string | nilReason on failure: restricted-value, invalid-unit-snapshot or unit-snapshot-read-error.

版本

内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API;某个 API 缺失时,辅助函数会改用后备方案,或返回 nil 并附上原因。

它不直接读取任何游戏 API。

秘密值(正式服和永久服)

在正式服和永久服上,游戏交给插件的是秘密值。此辅助函数会检查它读取的内容(addon.Platform:CanReadValue),遇到无法比较的秘密值时返回 nil 并附上原因(例如 restricted-value),而不是返回该秘密值。请将 nil 视为不可用,而不是假。

插件如何调用它

源码

Core/threat_count_conditions.lua,第 33 行。在游戏中为只读;“复制”会生成一份可编辑的副本。

Core.threat_count_conditions.readField(platform, object, key)
    if not platform:CanReadValue(object) then return nil,'restricted-value' end
    if type(object)~='table' then return nil,'invalid-unit-snapshot' end
    local ok,value=pcall(function() return object[key] end)
    if not ok then return nil,'unit-snapshot-read-error' end
    if not platform:CanReadValue(value) then return nil,'restricted-value' end
    return value

返回函数参考