Platform.spells.copy

呼叫方式

Platform.spells.copy(record, fields)

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

作用

Copies the expected fields of a native result table into a new table, checking each type. fields maps a key to its Lua type name ("icon" accepts a number or a string). Returns the copy with absent fields omitted, or nil with "restricted-value" when the record or a field is secret, or "invalid-api-result" when record is not a table, a field has the wrong type or a number is NaN or infinite.

參數

名稱	類型	作用
`record`	`any`	Native result table to copy.
`fields`	`table`	Map of field name to expected type name.

傳回值

1	`table \| nil`	New table holding only the expected, present fields; nil on failure.
2	`string \| nil`	Reason on failure.

版本

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

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

機密值（正式版與永久）

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

插件如何呼叫它

Platform.spells.own

if not built then return copy(record, fields) end

相依項目

platform (builtin:Platform/spells.lua:platform)

原始碼

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

Platform.spells.copy(record, fields)

    if not platform:CanReadValue(record) then return nil, "restricted-value" end
    if type(record) ~= "table" then return nil, "invalid-api-result" end
    local result = {}
    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
            result[key] = value
        end
    end
    return result

返回函式參考