Add @meta for all files. Mark couple params as optional.

This commit is contained in:
Alexander Chibrikin
2026-01-26 16:46:40 +03:00
parent a8a2da4059
commit 966a08b597
47 changed files with 90 additions and 23 deletions

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- `AreaStore` is a data structure to calculate intersections of 3D cuboid volumes and points.

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- @class HTTPRequestHandle

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- @class InvRef

View File

@@ -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

View File

@@ -1,3 +1,6 @@
--- @meta
--- @class LuaEntity
--- @field name string
--- @field object Entity

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],

View File

@@ -1,3 +1,5 @@
--- @meta
--- ItemStack metadata: reference extra data and functionality stored in a stack.
--- Can be obtained via `item:get_meta()`.
---

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- Node metadata: reference extra data and functionality stored in a node.

View File

@@ -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.

View File

@@ -1,3 +1,6 @@
--- @meta
--- Mod metadata: per mod metadata, saved automatically.
--- Can be obtained via `core.get_mod_storage()` during load time.
---

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- Node Timers: a high resolution persistent per-node timer.

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- @class ObjectRef

View File

@@ -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

View File

@@ -1,4 +1,5 @@
--- @diagnostic disable: missing-return
--- @meta
--- A fast, bulk noise generator.
---

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- @class VoxelArea

View File

@@ -1,4 +1,4 @@
--- @diagnostic disable: missing-return
--- @meta
--- @class VoxelManip

View File

@@ -1,4 +1,5 @@
--- @diagnostic disable: missing-return
--- @meta
--- @class vector: Position
--- @operator eq : boolean