diff --git a/classes/AreaStore.lua b/classes/AreaStore.lua index 5261dda..cc8d230 100644 --- a/classes/AreaStore.lua +++ b/classes/AreaStore.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- `AreaStore` is a data structure to calculate intersections of 3D cuboid volumes and points. diff --git a/classes/HTTPApiTable.lua b/classes/HTTPApiTable.lua index 2971946..234bda1 100644 --- a/classes/HTTPApiTable.lua +++ b/classes/HTTPApiTable.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- @class HTTPRequestHandle diff --git a/classes/InvRef.lua b/classes/InvRef.lua index c10a7c2..f85261e 100644 --- a/classes/InvRef.lua +++ b/classes/InvRef.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- @class InvRef diff --git a/classes/ItemStack.lua b/classes/ItemStack.lua index 1e69b0f..c5418b4 100644 --- a/classes/ItemStack.lua +++ b/classes/ItemStack.lua @@ -100,7 +100,7 @@ function ItemStack:peek_item(count) end function ItemStack:replace(item) end --- Take (and remove) up to n items from this stack; returns taken ItemStack; if n is omitted, n=1 is used ---- @param count number +--- @param count? number --- @return ItemStack function ItemStack:take_item(count) end diff --git a/classes/LuaEntity.lua b/classes/LuaEntity.lua index 7fe381c..41ab90e 100644 --- a/classes/LuaEntity.lua +++ b/classes/LuaEntity.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class LuaEntity --- @field name string --- @field object Entity diff --git a/classes/MetaDataRef.lua b/classes/MetaDataRef.lua index fe5540a..c3046a4 100644 --- a/classes/MetaDataRef.lua +++ b/classes/MetaDataRef.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`], diff --git a/classes/MetaDataRef/ItemStackMetaRef.lua b/classes/MetaDataRef/ItemStackMetaRef.lua index 88bd721..b07ba6f 100644 --- a/classes/MetaDataRef/ItemStackMetaRef.lua +++ b/classes/MetaDataRef/ItemStackMetaRef.lua @@ -1,3 +1,5 @@ +--- @meta + --- ItemStack metadata: reference extra data and functionality stored in a stack. --- Can be obtained via `item:get_meta()`. --- diff --git a/classes/MetaDataRef/NodeMetaRef.lua b/classes/MetaDataRef/NodeMetaRef.lua index b190ce0..499f326 100644 --- a/classes/MetaDataRef/NodeMetaRef.lua +++ b/classes/MetaDataRef/NodeMetaRef.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Node metadata: reference extra data and functionality stored in a node. diff --git a/classes/MetaDataRef/PlayerMetaRef.lua b/classes/MetaDataRef/PlayerMetaRef.lua index 71bd1b5..2068098 100644 --- a/classes/MetaDataRef/PlayerMetaRef.lua +++ b/classes/MetaDataRef/PlayerMetaRef.lua @@ -1,3 +1,6 @@ +--- @meta + + --- Player metadata. --- Uses the same method of storage as the deprecated player attribute API, so --- data there will also be in player meta. diff --git a/classes/MetaDataRef/StorageRef.lua b/classes/MetaDataRef/StorageRef.lua index bbaa527..f8d4de0 100644 --- a/classes/MetaDataRef/StorageRef.lua +++ b/classes/MetaDataRef/StorageRef.lua @@ -1,3 +1,6 @@ +--- @meta + + --- Mod metadata: per mod metadata, saved automatically. --- Can be obtained via `core.get_mod_storage()` during load time. --- diff --git a/classes/NodeTimerRef.lua b/classes/NodeTimerRef.lua index d601390..90ec5bb 100644 --- a/classes/NodeTimerRef.lua +++ b/classes/NodeTimerRef.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Node Timers: a high resolution persistent per-node timer. diff --git a/classes/ObjectRef.lua b/classes/ObjectRef.lua index eb4f911..f2ce680 100644 --- a/classes/ObjectRef.lua +++ b/classes/ObjectRef.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- @class ObjectRef diff --git a/classes/ValueNoise.lua b/classes/ValueNoise.lua index fc9b99c..dfe9289 100644 --- a/classes/ValueNoise.lua +++ b/classes/ValueNoise.lua @@ -1,4 +1,5 @@ ---- @diagnostic disable: missing-return +--- @meta + --- A value noise generator. It can be created via ValueNoise() or core.get_value_noise(). --- For core.get_value_noise(), the actual seed used is the noiseparams seed plus the world diff --git a/classes/ValueNoiseMap.lua b/classes/ValueNoiseMap.lua index bb33de5..442b692 100644 --- a/classes/ValueNoiseMap.lua +++ b/classes/ValueNoiseMap.lua @@ -1,4 +1,5 @@ ---- @diagnostic disable: missing-return +--- @meta + --- A fast, bulk noise generator. --- diff --git a/classes/VoxelArea.lua b/classes/VoxelArea.lua index 90a32de..c9ea10a 100644 --- a/classes/VoxelArea.lua +++ b/classes/VoxelArea.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- @class VoxelArea diff --git a/classes/VoxelManip.lua b/classes/VoxelManip.lua index 16a094b..d488c1d 100644 --- a/classes/VoxelManip.lua +++ b/classes/VoxelManip.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- @class VoxelManip diff --git a/classes/vector.lua b/classes/vector.lua index 106b6b5..e45de3a 100644 --- a/classes/vector.lua +++ b/classes/vector.lua @@ -1,4 +1,5 @@ ---- @diagnostic disable: missing-return +--- @meta + --- @class vector: Position --- @operator eq : boolean diff --git a/core_namespace.lua b/core_namespace.lua index b0fea17..9b2a076 100644 --- a/core_namespace.lua +++ b/core_namespace.lua @@ -1606,7 +1606,7 @@ function core.item_place_object(itemstack, placer, pointed_thing) end --- @param itemstack ItemStack --- @param placer Player|ObjectRef|nil --- @param pointed_thing pointed_thing ---- @param param2 number +--- @param param2? number --- @return ItemStack, vector|nil function core.item_place(itemstack, placer, pointed_thing, param2) end diff --git a/core_namespace/logging.lua b/core_namespace/logging.lua index 9099791..9ece496 100644 --- a/core_namespace/logging.lua +++ b/core_namespace/logging.lua @@ -1,3 +1,5 @@ +--- @meta + --- Equivalent to `core.log(table.concat({...}, "\t"))` --- diff --git a/core_namespace/registration/gameplay.lua b/core_namespace/registration/gameplay.lua index 92e7a30..b99739f 100644 --- a/core_namespace/registration/gameplay.lua +++ b/core_namespace/registration/gameplay.lua @@ -1,5 +1,6 @@ --- @meta + --- Registers a crafting recipe. --- * Check recipe table syntax for different types below. --- [TODO]: Link to recipe table syntax documentation. diff --git a/core_namespace/utilities.lua b/core_namespace/utilities.lua index 1e86274..55887c2 100644 --- a/core_namespace/utilities.lua +++ b/core_namespace/utilities.lua @@ -1,4 +1,5 @@ ---- @diagnostic disable: missing-return +--- @meta + --- Returns the currently loading mod's name, when loading a mod. --- - Returns nil if not loading a mod. diff --git a/definitions/ABMDefinition.lua b/definitions/ABMDefinition.lua index 9c20522..c897074 100644 --- a/definitions/ABMDefinition.lua +++ b/definitions/ABMDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class ABMDefinition local ABMDefinition = { --- Descriptive label for profiling purposes (optional). diff --git a/definitions/AuthenticationHandlerDefinition.lua b/definitions/AuthenticationHandlerDefinition.lua index a63d733..26fa403 100644 --- a/definitions/AuthenticationHandlerDefinition.lua +++ b/definitions/AuthenticationHandlerDefinition.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta ---@class AuthenticationHandlerGetAuth diff --git a/definitions/BiomeDefinition.lua b/definitions/BiomeDefinition.lua index 75e5498..c32f3de 100644 --- a/definitions/BiomeDefinition.lua +++ b/definitions/BiomeDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class BiomeDefinition --- Definition of a biome for use with `core.register_biome`. local BiomeDefinition = { diff --git a/definitions/ChatCommandDefinition.lua b/definitions/ChatCommandDefinition.lua index 48b0c3c..156fc39 100644 --- a/definitions/ChatCommandDefinition.lua +++ b/definitions/ChatCommandDefinition.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Used by `core.register_chatcommand`. diff --git a/definitions/DetachedInventoryCallbacksDef.lua b/definitions/DetachedInventoryCallbacksDef.lua index c3797d0..d3421ca 100644 --- a/definitions/DetachedInventoryCallbacksDef.lua +++ b/definitions/DetachedInventoryCallbacksDef.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class DetachedInventoryCallbacksDef local DetachedInventoryCallbacksDef = { --- Called when a player wants to move items inside the inventory. diff --git a/definitions/EntityDefinition.lua b/definitions/EntityDefinition.lua index cbdcfd4..c88c126 100644 --- a/definitions/EntityDefinition.lua +++ b/definitions/EntityDefinition.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Used by `core.register_entity`. diff --git a/definitions/HTTPRequestDefinition.lua b/definitions/HTTPRequestDefinition.lua index c2087c1..431ba17 100644 --- a/definitions/HTTPRequestDefinition.lua +++ b/definitions/HTTPRequestDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`. ---@class HTTPRequest: table local HTTPRequest = { diff --git a/definitions/HTTPRequestResultDefinition.lua b/definitions/HTTPRequestResultDefinition.lua index 3dedb13..01f818b 100644 --- a/definitions/HTTPRequestResultDefinition.lua +++ b/definitions/HTTPRequestResultDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- Passed to `HTTPApiTable.fetch` callback. Returned by `HTTPApiTable.fetch_async_get`. ---@class HTTPRequestResult: table local HTTPRequestResult = { diff --git a/definitions/HUDDefinition.lua b/definitions/HUDDefinition.lua index 9dfb6b5..bb20d4f 100644 --- a/definitions/HUDDefinition.lua +++ b/definitions/HUDDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class HudDefinition local HudDefinition = { --- Name of the HUD element. diff --git a/definitions/ItemDefinition.lua b/definitions/ItemDefinition.lua index b8d758f..8c69112 100644 --- a/definitions/ItemDefinition.lua +++ b/definitions/ItemDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class ItemDefinition: table local ItemDefinition = { --- Can contain new lines. "\n" has to be used as new line character. diff --git a/definitions/LBMDefinition.lua b/definitions/LBMDefinition.lua index f8e4bbd..b2339f0 100644 --- a/definitions/LBMDefinition.lua +++ b/definitions/LBMDefinition.lua @@ -1,3 +1,4 @@ +--- @meta --- @class LBMDefinition diff --git a/definitions/LSystemTreeDefinition.lua b/definitions/LSystemTreeDefinition.lua index 8d89487..9251425 100644 --- a/definitions/LSystemTreeDefinition.lua +++ b/definitions/LSystemTreeDefinition.lua @@ -1,3 +1,5 @@ +--- @meta + --- @class LSystemTreeDefinition --- @field axiom string initial tree axiom diff --git a/definitions/NodeDefinition.lua b/definitions/NodeDefinition.lua index 7a1b2d0..c88a2fb 100644 --- a/definitions/NodeDefinition.lua +++ b/definitions/NodeDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class NodeDefinition: ItemDefinition local NodeDefinition = { diff --git a/definitions/NoiseParams.lua b/definitions/NoiseParams.lua index c7050b4..c29f359 100644 --- a/definitions/NoiseParams.lua +++ b/definitions/NoiseParams.lua @@ -1,3 +1,6 @@ +--- @meta + + --- For 2D or 3D value noise or value noise maps: --- --- ```lua diff --git a/definitions/ObjectProperties.lua b/definitions/ObjectProperties.lua index f04c9c6..d148d75 100644 --- a/definitions/ObjectProperties.lua +++ b/definitions/ObjectProperties.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class ObjectProperties local ObjectProperties = { --- Defines the maximum and default HP of the entity diff --git a/definitions/OreDefinition.lua b/definitions/OreDefinition.lua index feb1825..6d9e86f 100644 --- a/definitions/OreDefinition.lua +++ b/definitions/OreDefinition.lua @@ -1,3 +1,5 @@ +--- @meta + --- @class OreDefinition --- Defines an ore to be registered with `core.register_ore`. diff --git a/definitions/PrivilegeDefinition.lua b/definitions/PrivilegeDefinition.lua index 0e18b7d..90a8445 100644 --- a/definitions/PrivilegeDefinition.lua +++ b/definitions/PrivilegeDefinition.lua @@ -1,4 +1,5 @@ ---- @diagnostic disable: missing-return +--- @meta + --- Used by `core.register_privilege`. --- @class PrivilegeDefinition diff --git a/definitions/TileAnimationDefinition.lua b/definitions/TileAnimationDefinition.lua index 50a4573..861d3ed 100644 --- a/definitions/TileAnimationDefinition.lua +++ b/definitions/TileAnimationDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class TileAnimationDefinition: table local TileAnimationDefinition = { --- @type string one of {"vertical_frames"|"sheet_2d"} diff --git a/definitions/TileDefinition.lua b/definitions/TileDefinition.lua index 3134e9a..be4fc11 100644 --- a/definitions/TileDefinition.lua +++ b/definitions/TileDefinition.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class TileDefinition local TileDefinition = { --- @type string diff --git a/lua_ext/math.lua b/lua_ext/math.lua index 82716b7..ad35a51 100644 --- a/lua_ext/math.lua +++ b/lua_ext/math.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Get the hypotenuse of a triangle with legs x and y. Useful for distance calculation. diff --git a/lua_ext/string.lua b/lua_ext/string.lua index b82acdf..c17189d 100644 --- a/lua_ext/string.lua +++ b/lua_ext/string.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- e.g. `"a,b":split(",")` returns `{"a","b"}` diff --git a/lua_ext/table.lua b/lua_ext/table.lua index 490371a..f69ea32 100644 --- a/lua_ext/table.lua +++ b/lua_ext/table.lua @@ -1,4 +1,4 @@ ---- @diagnostic disable: missing-return +--- @meta --- Returns a deep copy of `table` diff --git a/specs/Color.lua b/specs/Color.lua index 4977370..f480c86 100644 --- a/specs/Color.lua +++ b/specs/Color.lua @@ -1,3 +1,5 @@ +--- @meta + --- A ColorString is a string that represents a color. It can be one of the following: --- * a named color, e.g. `"red"`, `"blue"`, `"green"`, etc. diff --git a/specs/SchematicSpecifier.lua b/specs/SchematicSpecifier.lua index 15930ef..5a63416 100644 --- a/specs/SchematicSpecifier.lua +++ b/specs/SchematicSpecifier.lua @@ -1,4 +1,4 @@ ---- @mete +--- @meta --- A schematic specifier identifies a schematic by either a filename to a Luanti Schematic file (.mts) or through raw data supplied through Lua, in the form of a table. diff --git a/specs/SimpleSoundSpec.lua b/specs/SimpleSoundSpec.lua index f16335a..865233b 100644 --- a/specs/SimpleSoundSpec.lua +++ b/specs/SimpleSoundSpec.lua @@ -1,3 +1,6 @@ +--- @meta + + --- @class SimpleSoundSpec local SimpleSoundSpec = { --- Scales the gain specified in `SimpleSoundSpec`. diff --git a/specs/TextureModifier.lua b/specs/TextureModifier.lua index 3cb83d1..4de8afc 100644 --- a/specs/TextureModifier.lua +++ b/specs/TextureModifier.lua @@ -1,3 +1,5 @@ +--- @meta + --- **Texture overlaying:** `^`. --- **Texture grouping:** `(` and `)`.