Splitting NodeDefinition into settings and callbacks, updating annotations to 5.16
This commit is contained in:
193
definitions/NodeDefinition/Callbacks.lua
Normal file
193
definitions/NodeDefinition/Callbacks.lua
Normal file
@@ -0,0 +1,193 @@
|
||||
---Version: 5.16
|
||||
---@meta
|
||||
|
||||
---@class NodeDefinition.Callbacks : ItemDefinition.Callbacks
|
||||
local Callbacks = {}
|
||||
|
||||
---Node constructor; called after adding node.
|
||||
---
|
||||
---Can set up metadata and stuff like that.
|
||||
---
|
||||
---Not called for bulk node placement (i.e. schematics and VoxelManip).
|
||||
---
|
||||
---Note: Within an `on_construct` callback, `core.set_node` can cause an
|
||||
---infinite loop if it invokes the same callback.
|
||||
---
|
||||
---Consider using `core.swap_node` instead.
|
||||
---
|
||||
---default: `nil`
|
||||
---@type fun(pos:MapVector)?
|
||||
Callbacks.on_construct = nil
|
||||
|
||||
---Node destructor; called before removing node.
|
||||
---
|
||||
---Not called for bulk node placement.
|
||||
---
|
||||
---default: `nil`
|
||||
---@type fun(pos:MapVector)?
|
||||
Callbacks.on_destruct = nil
|
||||
|
||||
---Node destructor; called after removing node.
|
||||
---
|
||||
---Not called for bulk node placement.
|
||||
---
|
||||
---default: `nil`
|
||||
---@type fun(pos:MapVector, oldnode:NodeTable)?
|
||||
Callbacks.after_destruct = nil
|
||||
|
||||
---Called when a liquid (newnode) is about to flood oldnode, if it has
|
||||
---`floodable = true` in the nodedef. Not called for bulk node placement
|
||||
---(i.e. schematics and VoxelManip) or air nodes. If return true the
|
||||
---node is not flooded, but on_flood callback will most likely be called
|
||||
---over and over again every liquid update interval.
|
||||
---
|
||||
---Default: `nil`
|
||||
---
|
||||
---**Warning**: making a liquid node 'floodable' will cause problems.
|
||||
---@type (fun(pos:MapVector, oldnode:NodeTable, newnode:NodeTable):boolean?)?
|
||||
Callbacks.on_flood = nil
|
||||
|
||||
|
||||
---Called when `oldnode` is about be converted to an item, but before the
|
||||
---node is deleted from the world or the drops are added. This is
|
||||
---generally the result of either the node being dug or an attached node
|
||||
---becoming detached.
|
||||
--- * `pos`: node position
|
||||
--- * `oldnode`: node table of node before it was deleted
|
||||
--- * `oldmeta`: metadata of node before it was deleted, as a metadata table
|
||||
--- * `drops`: a table of `ItemStack`s, so any metadata to be preserved can
|
||||
--- be added directly to one or more of the dropped items. See [ItemStackMetaRef](lua://ItemStackMetaRef).
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type fun(pos:MapVector, oldnode:NodeTable, newnode:NodeTable, oldmeta:NodeMetaRef, drops:ItemStack[])?
|
||||
Callbacks.preserve_metadata = nil
|
||||
|
||||
---Called after constructing node when node was placed using
|
||||
---`core.item_place_node` / `core.place_node`.
|
||||
---
|
||||
---If return `true` no item is taken from itemstack.
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type (fun(pos:MapVector, placer:Player|ObjectRef|nil, itemstack:ItemStack, pointed_thing:pointed_thing):boolean?)?
|
||||
Callbacks.after_place_node = nil
|
||||
|
||||
---Called after destructing the node when node was dug using
|
||||
---`core.node_dig` / `core.dig_node`.
|
||||
---
|
||||
--- * `pos`: node position
|
||||
--- * `oldnode`: node table of node before it was dug
|
||||
--- * `oldmetadata`: metadata of node before it was dug, as a metadata table
|
||||
--- * `digger`: ObjectRef of digger
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type fun(pos:Player, oldnode:NodeMetaRef, oldmetadata:NodeMetaRef, digger:Player|ObjectRef|nil)?
|
||||
Callbacks.after_dig_node = nil
|
||||
|
||||
---Returns `true` if node can be dug, or `false` if not.
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type (fun(pos:MapVector, player:Player|ObjectRef|nil):boolean)?
|
||||
Callbacks.can_dig = nil
|
||||
|
||||
---Called when puncher (an ObjectRef) punches the node at pos.
|
||||
---
|
||||
---By default calls `core.register_on_punchnode` callbacks.
|
||||
---
|
||||
---Default: `core.node_punch`
|
||||
---@type fun(pos:MapVector, node:NodeTable, puncher:Player|ObjectRef, pointed_thing:pointed_thing)?
|
||||
Callbacks.on_punch = nil
|
||||
|
||||
---Called when clicker (an ObjectRef) used the 'place/build' key
|
||||
---(not necessarily an actual rightclick)
|
||||
---while pointing at the node at pos with 'node' being the node table.
|
||||
---
|
||||
---itemstack will hold clicker's wielded item.
|
||||
---
|
||||
---Shall return the leftover itemstack.
|
||||
---
|
||||
---**Note**: pointed_thing can be `nil`, if a mod calls this function.
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type (fun(pos:MapVector, node:NodeTable, clicker:Player|ObjectRef, itemstack:ItemStack, pointed_thing:pointed_thing?):ItemStack|nil)?
|
||||
Callbacks.on_rightclick = nil
|
||||
|
||||
---By default checks privileges, wears out item (if tool) and removes node.
|
||||
---
|
||||
---Return `true` if the node was dug successfully, `false` otherwise.
|
||||
---
|
||||
---Deprecated: returning `nil` is the same as returning `true`.
|
||||
---
|
||||
---Default: `core.node_dig`
|
||||
---@type (fun(pos:MapVector, node:NodeTable, digger:Player):boolean)?
|
||||
Callbacks.on_dig = nil
|
||||
|
||||
---Called by NodeTimers, see `core.get_node_timer` and [NodeTimerRef](lua://NodeTimerRef).
|
||||
---
|
||||
--- * `elapsed`: total time passed since the timer was started.
|
||||
--- * `node`: node table (since 5.14)
|
||||
--- * `timeout`: timeout value of the just ended timer (since 5.14)
|
||||
---
|
||||
---Return `true` to run the timer for another cycle with the same timeout value.
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type (fun(pos:MapVector, elapsed:number, node:NodeTable, timeout:number):boolean?)?
|
||||
Callbacks.on_timer = nil
|
||||
|
||||
---Fields = {name1 = value1, name2 = value2, ...}
|
||||
---
|
||||
---Formname should be the empty string; you **must not** use formname.
|
||||
---
|
||||
---Called when an UI form (e.g. sign text input) returns data.
|
||||
---
|
||||
---See `core.register_on_player_receive_fields` for more info.
|
||||
---
|
||||
---Default: `nil`
|
||||
---@type fun(pos:MapVector, formname:string, fields:table<string, any>, sender:Player)?
|
||||
Callbacks.on_receive_fields = nil
|
||||
|
||||
---Called when a player wants to move items inside the inventory.
|
||||
---
|
||||
---Return value: number of items allowed to put.
|
||||
---@type (fun(pos:MapVector, from_list:string, from_index:integer, to_list:string, to_index:integer, count:integer, player:Player):number)?
|
||||
Callbacks.allow_metadata_inventory_move = nil
|
||||
|
||||
---Called when a player wants to put something into the inventory.
|
||||
---
|
||||
---Return value: number of items allowed to take.
|
||||
---
|
||||
---Return value -1: Allow and don't modify item count in inventory.
|
||||
---@type (fun(pos:MapVector, listname:string, index:integer, stack:ItemStack, player:Player):number)?
|
||||
Callbacks.allow_metadata_inventory_put = nil
|
||||
|
||||
---Called when a player wants to take something out of the inventory.
|
||||
---
|
||||
---Return value: number of items allowed to take.
|
||||
---
|
||||
---Return value -1: Allow and don't modify item count in inventory.
|
||||
---@type (fun(pos:MapVector, listname:string, index:integer, stack:ItemStack, player:Player):number)?
|
||||
Callbacks.allow_metadata_inventory_take = nil
|
||||
|
||||
---Called after the actual action has happened, according to what was allowed.
|
||||
---
|
||||
---No return value.
|
||||
---@type fun(pos:MapVector, from_list:string, from_index:integer, to_list:string, to_index:integer, count:integer, player:Player)?
|
||||
Callbacks.on_metadata_inventory_move = nil
|
||||
|
||||
---Called after the actual action has happened, according to what was allowed.
|
||||
---
|
||||
---No return value.
|
||||
---@type fun(pos:MapVector, listname:string, index:number, stack:ItemStack, player:Player)?
|
||||
Callbacks.on_metadata_inventory_put = nil
|
||||
|
||||
---Called after the actual action has happened, according to what was allowed.
|
||||
---
|
||||
---No return value.
|
||||
---@type fun(pos:MapVector, listname:string, index:number, stack:ItemStack, player:Player)?
|
||||
Callbacks.on_metadata_inventory_take = nil
|
||||
|
||||
---If defined, called when an explosion touches the node, instead of
|
||||
---removing the node.
|
||||
---
|
||||
--- * `intensity`: 1.0 = mid range of regular TNT.
|
||||
---@type fun(pos:MapVector, intensity:number)?
|
||||
Callbacks.on_blast = nil
|
||||
Reference in New Issue
Block a user