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

Make documentation about ItemStack:set_{name,count,wear} clearer

Browse Source 
These methods do not actually fail but instead clear the item stack
	and return false if a value like e.g. "" is passed.
This commit is contained in:
sfan5 2016-10-14 13:08:59 +02:00
parent a468acce2c
commit 9a3129da5e
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/lua_api.txt
View File

@ -2966,13 +2966,11 @@ an itemstring, a table or `nil`.
#### Methods
* `is_empty()`: Returns `true` if stack is empty.
* `get_name()`: Returns item name (e.g. `"default:stone"`).
* `set_name(item_name)`: Returns boolean success.
Clears item on failure.
* `set_name(item_name)`: Returns boolean whether item was cleared
* `get_count()`: Returns number of items on the stack.
* `set_count(count)`
* `set_count(count)`: Returns boolean whether item was cleared
* `get_wear()`: Returns tool wear (`0`-`65535`), `0` for non-tools.
* `set_wear(wear)`: Returns boolean success.
Clears item on failure.
* `set_wear(wear)`: Returns boolean whether item was cleared
* `get_metadata()`: Returns metadata (a string attached to an item stack).
* `set_metadata(metadata)`: Returns true.
* `clear()`: removes all items from the stack, making it empty.