LBMDefinition: update annotations
This commit is contained in:
@@ -1,11 +1,10 @@
|
|||||||
--- @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
|
||||||
@@ -29,7 +28,7 @@ local LBMDefinition = {
|
|||||||
--- 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.
|
||||||
@@ -37,6 +36,6 @@ local LBMDefinition = {
|
|||||||
--- - 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,
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user