LBMDefinition: update annotations

This commit is contained in:
Van
2026-06-07 22:08:40 +03:00
parent 08af76c702
commit e0862e8170

View File

@@ -1,42 +1,41 @@
--- @meta --- @meta
--- @class LBMDefinition --- @class LBMDefinition
local LBMDefinition = { local LBMDefinition = {
--- Descriptive label for profiling purposes (optional). --- Descriptive label for profiling purposes (optional).
--- Definitions with identical labels will be listed as one. --- Definitions with identical labels will be listed as one.
--- @type string --- @type string?
label = "Upgrade legacy doors", label = "Upgrade legacy doors",
--- Identifier of the LBM, should follow the modname:<whatever> convention --- Identifier of the LBM, should follow the modname:<whatever> convention
--- @type string --- @type string
name = "modname:replace_legacy_door", name = "modname:replace_legacy_door",
--- - List of node names to trigger the LBM on. --- - List of node names to trigger the LBM on.
--- - Names of non-registered nodes and groups (as group:groupname) will work as well. --- - Names of non-registered nodes and groups (as group:groupname) will work as well.
--- @type string[] --- @type string[]
nodenames = {"default:lava_source"}, nodenames = {"default:lava_source"},
--- If `false`: The LBM only runs on mapblocks the first time they are --- If `false`: The LBM only runs on mapblocks the first time they are
--- activated after the LBM was introduced. --- activated after the LBM was introduced.
--- It never runs on mapblocks generated after the LBM's introduction. --- It never runs on mapblocks generated after the LBM's introduction.
--- See above for details: https://api.luanti.org/definition-tables/#lbm-loadingblockmodifier-definition --- See above for details: https://api.luanti.org/definition-tables/#lbm-loadingblockmodifier-definition
--- ---
--- If `true`: The LBM runs every time a mapblock is activated. --- If `true`: The LBM runs every time a mapblock is activated.
--- @type boolean? --- @type boolean?
run_at_every_load = false, run_at_every_load = false,
--- Function triggered for each qualifying node. --- Function triggered for each qualifying node.
--- `dtime` is the in-game time (in seconds) elapsed since the mapblock --- `dtime` is the in-game time (in seconds) elapsed since the mapblock
--- was last active (available since 5.7.0). --- was last active (available since 5.7.0).
--- @type fun(pos:MapPosition, node:NodeTable, dtime:number)? --- @type fun(pos:MapVector, node:NodeTable, dtime:number)?
action = function(pos, node, dtime) end, action = function(pos, node, dtime) end,
--- Function triggered with a list of all applicable node positions at once. --- Function triggered with a list of all applicable node positions at once.
--- - This can be provided as an alternative to `action` (not both). --- - This can be provided as an alternative to `action` (not both).
--- - Available since `core.features.bulk_lbms` (5.10.0) --- - Available since `core.features.bulk_lbms` (5.10.0)
--- - `dtime` is the in-game time (in seconds) elapsed since the mapblock --- - `dtime` is the in-game time (in seconds) elapsed since the mapblock
--- was last active (available since 5.7.0). --- was last active (available since 5.7.0).
--- @type fun(pos_list:MapPosition[], dtime:number)? --- @type fun(pos_list:MapVector[], dtime:number)?
bulk_action = function(pos_list, dtime) end, bulk_action = function(pos_list, dtime) end,
} }