Make documentation about ItemStack:set_{name,count,wear} clearer
authorsfan5 <sfan5@live.de>
Fri, 14 Oct 2016 11:08:59 +0000 (13:08 +0200)
committersfan5 <sfan5@live.de>
Sat, 15 Oct 2016 10:42:59 +0000 (12:42 +0200)
These methods do not actually fail but instead clear the item stack
and return false if a value like e.g. "" is passed.

doc/lua_api.txt

index a1d598e7de49fdfa890f0550f7465fcd39ca0280..8cb3f72bd1bc2b830c3113d182e310ba494df1e4 100644 (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.