luanti-org/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-10-21 03:55:21 +02:00
Code Activity

Adding missing description of new API functions

Browse Source 
Added description for:
* minetest.register_on_inventory_move_item
* minetest.register_on_inventory_add_item
* minetest.register_on_inventory_drop_item
* ObjRev:add_item
This commit is contained in:
Foghrye4
2016-04-11 19:37:31 +04:00
parent 4e2f8f2f69
commit bca6164937
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/lua_api.txt
View File

@@ -1881,6 +1881,33 @@ Call these functions only at load time!
* Called when a player joins the game
* `minetest.register_on_leaveplayer(func(ObjectRef))`
* Called when a player leaves the game
* `minetest.register_on_inventory_move_item(func(inv_from,list_from,slot_from,inv_to,list_to,slot_to,stack,amount,player)`
* Called when a player move items between inventories using GUI (including crafting grid).
* `inv_from`: InvRef of inventory from which item was extracted.
* `list_from`: name of a list, where from stack extracted.
* `slot_from`: integer, speak by itself
* `inv_to`: InvRef of inventory to which item was dropped.
* `list_to`: name of a list, where to stack dropped.
* `slot_to`: integer, speak by itself
* `stack`: ItemStack of a stack moved
* `amount`: integer, amount of items, which was sucessfully transported
* `player`: ObjectRef of the player
* `minetest.register_on_inventory_add_item(func(inv_to,list_to,stack,stack_left,player)`
* Called when a player recive item via digging or from item entity or when `player:add_item(list, item)` called.
* `inv_to`: InvRef of inventory to which item was added.
* `list_to`: name of a list, where stack was added.
* `slot_to`: integer, speak by itself
* `stack`: ItemStack of a stack added
* `stack_left`: ItemStack of a stack which was left on ground
* `player`: ObjectRef of the player
* `minetest.register_on_inventory_drop_item(func(inv_from,list_from,slot_from,stack,player, dropped_pos)`
* Called when a player drop item on ground
* `inv_from`: InvRef of inventory from which item was dropped.
* `list_from`: name of a list, where from stack dropped. Usually 'main'.
* `slot_from`: integer, speak by itself
* `stack`: ItemStack of a stack dropped
* `player`: ObjectRef of the player
* `dropped_pos`: a table `{x=x_pos, y=y_pos, z=z_pos}`, where values contain absolute position of new item object.
* `minetest.register_on_cheat(func(ObjectRef, cheat))`
* Called when a player cheats
* `cheat`: `{type=<cheat_type>}`, where `<cheat_type>` is one of:
@@ -2572,6 +2599,7 @@ This is basically a reference to a C++ `ServerActiveObject`
* `get_hp()`: returns number of hitpoints (2 * number of hearts)
* `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
* `get_inventory()`: returns an `InvRef`
* `add_item(listname, stack)`: add item somewhere in list, returns leftover `ItemStack`. If object has no inventory, return `ItemStack`. Same as for `InvRef`, `player:add_item(listname, stack)` can be used instead of `player:get_inventory():add_item(listname, stack)`, but will launch callbacks registered by `minetest.register_on_inventory_add_item`.
* `get_wield_list()`: returns the name of the inventory list the wielded item is in
* `get_wield_index()`: returns the index of the wielded item
* `get_wielded_item()`: returns an `ItemStack`