调用方式
Platform.spells.own(record, fields, built)
记录依赖项 Platform.spells.own,然后按该名称调用。带命名空间的调用不会传入 self:请使用冒号调用,或自行传入该对象。
作用
Returns a record holding only the expected fields, each checked by type. A record it did not build itself, a table with a metatable or a non-table goes through copy; a plain table the caller built is checked and stripped of unexpected keys in place. Fails like copy, with "restricted-value" or "invalid-api-result".
参数
| 名称 | 类型 | 作用 |
|---|---|---|
record | any | Native result table, or a table the caller built from a legacy multi-value return. |
fields | table | Map of field name to expected type name. |
built | boolean | nil | True when the caller built record itself, so it may be modified in place. |
返回值
| 1 | table | nil | Record holding only the expected fields; nil on failure. |
|---|---|---|
| 2 | string | nil | Reason on failure. |
版本
内置辅助函数在每个版本上都会注册。不同的是它们读取的游戏 API;某个 API 缺失时,辅助函数会改用后备方案,或返回 nil 并附上原因。
它不直接读取任何游戏 API。
秘密值(正式服和永久服)
在正式服和永久服上,游戏交给插件的是秘密值。此辅助函数会检查它读取的内容(addon.Platform:CanReadValue),遇到无法比较的秘密值时返回 nil 并附上原因(例如 restricted-value),而不是返回该秘密值。请将 nil 视为不可用,而不是假。
插件如何调用它
Platform.spells.GetSpellChargeslocal charges,why=own(record,chargeFields,built)Platform.spells.GetSpellCooldownlocal cooldown, why = own(record, cooldownFields, built)
依赖项
copy→Platform.spells.copyplatform(builtin:Platform/spells.lua:platform)
源码
Platform/spells.lua,第 65 行。在游戏中为只读;“复制”会生成一份可编辑的副本。
Platform.spells.own(record, fields, built)
if not built then return copy(record, fields) end
if not platform:CanReadValue(record) then return nil, "restricted-value" end
if type(record) ~= "table" or getmetatable(record) ~= nil then return copy(record, fields) end
for key, kind in pairs(fields) do
local value = record[key]
if not platform:CanReadValue(value) then return nil, "restricted-value" end
if value ~= nil then
if type(value) ~= kind and not (kind == "icon" and (type(value) == "number" or type(value) == "string")) then
return nil, "invalid-api-result"
end
if type(value) == "number" and (value ~= value or value == math.huge or value == -math.huge) then
return nil, "invalid-api-result"
end
end
end
local key = next(record)
while key ~= nil do
local following = next(record, key)
if fields[key] == nil then record[key] = nil end
key = following
end
return record