From 0489e18385b2ab7d90e9c029bc8e95dd136588dc Mon Sep 17 00:00:00 2001 From: varttist Date: Tue, 16 Jun 2026 21:08:22 +0300 Subject: [PATCH] Update `MetaDataRef` & readme, rename readme and license --- license.md => LICENSE.md | 0 readme.md => README.md | 11 ++++++ classes/MetaDataRef.lua | 82 ++++++++++++++++++++++++++++++++-------- 3 files changed, 78 insertions(+), 15 deletions(-) rename license.md => LICENSE.md (100%) rename readme.md => README.md (77%) diff --git a/license.md b/LICENSE.md similarity index 100% rename from license.md rename to LICENSE.md diff --git a/readme.md b/README.md similarity index 77% rename from readme.md rename to README.md index 3015d74..b774697 100644 --- a/readme.md +++ b/README.md @@ -19,6 +19,17 @@ This ide-helper is specifically designed to support the [SMC game](https://git.a - Any editor with LSP support. Install Lua LS: `cargo install emmylua_ls` (or see [instalation guide](https://github.com/EmmyLuaLs/emmylua-analyzer-rust?tab=readme-ov-file#-installation)) +## Annotation up-to-dateness +Some annotations may be outdated for newer versions of Luanti, as the Luanti API Reference gradually changes. + +At the beginning of some files, there may be information about relevance in the form of a Luanti version: +```lua +---Version: 5.16 -- This means that the annotations were updated or verified with the documentation for Luanti 5.16. +---@meta +``` + +If you find a discrepancy between the ide-helper annotations and the Luanti API Reference, you can create an [issue](https://git.apancore.ru/Apancore.Studio/smc-luanti-ide-helper/issues) to notify the maintainers. + ## License This project is licensed under the MIT License - see [`license.md`](./license.md) file for details. \ No newline at end of file diff --git a/classes/MetaDataRef.lua b/classes/MetaDataRef.lua index c637d3f..2198668 100644 --- a/classes/MetaDataRef.lua +++ b/classes/MetaDataRef.lua @@ -1,3 +1,4 @@ +---Version: 5.16 ---@meta ---Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`], @@ -70,24 +71,75 @@ function MetaDataRef:set_float(key, value) end ---@return number function MetaDataRef:get_float(key) end ---- Returns a list of all keys in the metadata. ---- @return table +---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 +---Metadata tables represent MetaDataRef in a Lua table form (see `from_table`/`to_table`). +--- +---Example: +---```lua +---metadata_table = { +--- -- metadata fields (key/value store) +--- fields = { +--- infotext = "Container", +--- another_key = "Another Value", +--- }, +--- -- inventory data (for nodes) +--- inventory = { +--- -- inventory list "main" with 4 slots +--- main = { +--- -- list of all item slots +--- [1] = ItemStack("example:dirt"), +--- [2] = ItemStack("example:stone 25"), +--- [3] = ItemStack(""), -- empty slot +--- [4] = ItemStack("example:pickaxe"), +--- }, +--- -- inventory list "hidden" with 1 slot +--- hidden = { +--- [1] = ItemStack("example:diamond"), +--- }, +--- }, +---} +---``` +---@class MetaDataRef.Table +---Key-value storage of metadata fields. +--- +---All values are stored as strings. +--- +---Numbers must be converted to strings first. +---@field fields table +--- +---(for NodeMetaRef only): A node inventory in table form +--- +---Inventory table keys are inventory list names. +--- +---Inventory table values are item tables. +--- +---Item table keys are slot IDs (starting with 1). +--- +---Item table values are ItemStacks +---@field inventory table + +---Returns a [metadata table](lua://MetaDataRef.Table) or `nil` on failure. +---@return MetaDataRef.Table? 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 +---Imports metadata from a [metadata table](lua://MetaDataRef.Table). +--- +---If `data` is a metadata table, +---the metadata it represents will replace all metadata of this MetaDataRef object. +--- +---Any non-table value for `data` will clear all metadata. +--- +---Item table values the inventory field may also be itemstrings. +--- +---Returns `true` on success. +--- @param data MetaDataRef.Table? +--- @return boolean +function MetaDataRef:from_table(data) end ---- * returns `true` if this metadata has the same key-value pairs as `other` ---- @param other any ---- @return boolean +---Returns `true` if this metadata has the same key-value pairs as `other`. +---@param other any +---@return boolean function MetaDataRef:equals(other) end