diff options
author | Ciaran Gultnieks <ciaran@ciarang.com> | 2014-03-17 20:05:35 +0000 |
---|---|---|
committer | ShadowNinja <shadowninja@minetest.net> | 2014-11-28 18:35:45 -0500 |
commit | c30346ea3093ed96693e628493f5722c615ba138 (patch) | |
tree | 4b8a67e146336eabd97c3694f416f01763c46f40 /src/settings.h | |
parent | 2b1a151226ae274ca652e72e95b840199e9389b8 (diff) | |
download | minetest-c30346ea3093ed96693e628493f5722c615ba138.tar.gz minetest-c30346ea3093ed96693e628493f5722c615ba138.tar.bz2 minetest-c30346ea3093ed96693e628493f5722c615ba138.zip |
Improve Lua API documentation
Changes:
* Add extra documentation for remove_item.
This isn't as silly as it sounds: iterate a list containing items with
unique metadata each, and remove_item the first one you find, placing
into a different - fine, except the remove will invariably remove the
wrong one, leading to items being duplicated and others destroyed.
Arguably it's a bug, and Inventory::removeItem should actually remove
the item you tell it to. (i.e. if the passed ItemStack has metadata,
match it). But it seems reasonable to just document the behaviour
more clearly.
* Improve string_to_pos documentation.
* Clarify dig_node documentation (return value).
* Better on_step documentation.
* get_nodemeta -> get_meta.
* Other minor fixes.
Diffstat (limited to 'src/settings.h')
0 files changed, 0 insertions, 0 deletions