Mirrorlandia_minetest/minetest
1
0
Fork 1
mirror of https://github.com/minetest/minetest.git synced 2024-11-23 08:03:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation of inventory actions (#13181)

Browse Source 
The text was not clear enough on what these do exactly. It was written in a way that sounded like this allows you to capture ALL inventory changes of the player inventory. However, this is not true: It only captures inventory changes within the player inventory or when the item was exchanged with another inventory.
This commit is contained in:
Wuzzy 2023-03-19 20:25:08 +01:00 committed by GitHub
parent 0050f12b32
commit 09342c0811
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/lua_api.txt
View File

@ -5370,6 +5370,15 @@ Call these functions only at load time!
* `minetest.register_allow_player_inventory_action(function(player, action, inventory, inventory_info))`
* Determines how much of a stack may be taken, put or moved to a
player inventory.
* Function arguments: see `minetest.register_on_player_inventory_action`
* Return a numeric value to limit the amount of items to be taken, put or
moved. A value of `-1` for `take` will make the source stack infinite.
* `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
* Called after an item take, put or move event from/to/in a player inventory
* These inventory actions are recognized:
* move: Item was moved within the player inventory
* put: Item was put into player inventory from another inventory
* take: Item was taken from player inventory and put into another inventory
* `player` (type `ObjectRef`) is the player who modified the inventory
`inventory` (type `InvRef`).
* List of possible `action` (string) values and their
@ -5377,11 +5386,6 @@ Call these functions only at load time!
* `move`: `{from_list=string, to_list=string, from_index=number, to_index=number, count=number}`
* `put`: `{listname=string, index=number, stack=ItemStack}`
* `take`: Same as `put`
* Return a numeric value to limit the amount of items to be taken, put or
moved. A value of `-1` for `take` will make the source stack infinite.
* `minetest.register_on_player_inventory_action(function(player, action, inventory, inventory_info))`
* Called after a take, put or move event from/to/in a player inventory
* Function arguments: see `minetest.register_allow_player_inventory_action`
* Does not accept or handle any return value.
* `minetest.register_on_protection_violation(function(pos, name))`
* Called by `builtin` and mods when a player violates protection at a