Files
smc-luanti-ide-helper/classes/MetaDataRef.lua
2026-06-16 17:50:09 +03:00

94 lines
2.7 KiB
Lua

---@meta
---Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
---and [`PlayerMetaRef`].
---
---Note: If a metadata value is in the format `${k}`, an attempt to get the value
---will return the value associated with key `k`. There is a low recursion limit.
---This behavior is **deprecated** and will be removed in a future version. Usage
---of the `${k}` syntax in formspecs is not deprecated.
---
---@class MetaDataRef
MetaDataRef = {}
---Returns `true` if `key` present, otherwise `false`.
---
---Returns `nil` when the MetaData is inexistent.
---@param key string
---@return boolean?
function MetaDataRef:contains(key) end
---Returns the value stored at `key` as a string if present.
---
---Returns nil otherwise.
---@param key string
---@return string?
function MetaDataRef:get(key) end
---Set the string `value` at `key`.
---
---Value of `""` will delete the key.
---@param key string
---@param value string
function MetaDataRef:set_string(key, value) end
---Returns a string value at `key` or `""` if not present.
---@param key string
---@return string
function MetaDataRef:get_string(key) end
---Set an integer number `value` to `key`.
---
---Range: [s32].
---
---Some systems internally have a larger value range
---but but you should not rely on this behavior to ensure portability of your code.
---
---The value will be converted into a string when stored.
---@param key string
---@param value integer
function MetaDataRef:set_int(key, value) end
---Returns the value stored at `key` as an integer.
---
---Returns `0` if key not present.
---@param key string
---@return integer
function MetaDataRef:get_int(key) end
---Store a number (a 64-bit floating-point number) exactly.
---
---The value will be converted into a string when stored.
---@param key string
---@param value number
function MetaDataRef:set_float(key, value) end
---Returns a 64-bit floating-point number stored at `key`.
---
---Returns `0` if key not present.
---@param key string
---@return number
function MetaDataRef:get_float(key) end
--- Returns a list of all keys in the metadata.
--- @return table
function MetaDataRef:get_keys() end
--- returns `nil` or a table with keys:
--- * `fields`: key-value storage
--- * `inventory`: `{list1 = {}, ...}}` (NodeMetaRef only)
--- @return table|nil
function MetaDataRef:to_table() end
--- * Any non-table value will clear the metadata
--- * See [Node Metadata] for an example
--- * returns `true` on success
--- @param value table|nil
--- @return boolean
function MetaDataRef:from_table(value) end
--- * returns `true` if this metadata has the same key-value pairs as `other`
--- @param other any
--- @return boolean
function MetaDataRef:equals(other) end