Improve documentation of minetest.get_node_drops()
authorsfan5 <sfan5@live.de>
Thu, 26 Mar 2020 19:28:44 +0000 (20:28 +0100)
committersfan5 <sfan5@live.de>
Thu, 26 Mar 2020 19:35:05 +0000 (20:35 +0100)
Also remove the comment saying it could be removed or modified.

doc/lua_api.txt

index b67f70631b93ff0f799c215d3573ad1d75f045ca..c94af612523fb03476ba840774bcc1fc9dbb3d87 100644 (file)
@@ -4894,9 +4894,11 @@ Item handling
       given `param2` value.
     * Returns `nil` if the given `paramtype2` does not contain color
       information.
-* `minetest.get_node_drops(nodename, toolname)`
-    * Returns list of item names.
-    * **Note**: This will be removed or modified in a future version.
+* `minetest.get_node_drops(node, toolname)`
+    * Returns list of itemstrings that are dropped by `node` when dug
+      with `toolname`.
+    * `node`: node as table or node name
+    * `toolname`: name of the tool item (can be `nil`)
 * `minetest.get_craft_result(input)`: returns `output, decremented_input`
     * `input.method` = `"normal"` or `"cooking"` or `"fuel"`
     * `input.width` = for example `3`