aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDániel Juhász <juhdanad@gmail.com>2017-06-24 18:58:01 +0200
committerparamat <mat.gregory@virginmedia.com>2017-08-14 12:52:13 +0100
commit71b02d626f4a9629e0f282adef908eedc8ed252a (patch)
treee3c62c3e490ac27b60f611a43a7cc3a2704d7d2f /doc
parent4493d47a51dee4c785c009897ee4702850921503 (diff)
downloadminetest-71b02d626f4a9629e0f282adef908eedc8ed252a.tar.gz
minetest-71b02d626f4a9629e0f282adef908eedc8ed252a.tar.bz2
minetest-71b02d626f4a9629e0f282adef908eedc8ed252a.zip
Make dropped items colorable
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 66f8ccb25..dcc2de180 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -536,6 +536,21 @@ automatically transferred between node and item forms by the engine,
when a player digs or places a colored node.
You can disable this feature by setting the `drop` field of the node
to itself (without metadata).
+To transfer the color to a special drop, you need a drop table.
+Example:
+
+ minetest.register_node("mod:stone", {
+ description = "Stone",
+ tiles = {"default_stone.png"},
+ paramtype2 = "color",
+ palette = "palette.png",
+ drop = {
+ items = {
+ -- assume that mod:cobblestone also has the same palette
+ {items = {"mod:cobblestone"}, inherit_color = true },
+ }
+ }
+ })
### Colored items in craft recipes
Craft recipes only support item strings, but fortunately item strings
@@ -2688,6 +2703,13 @@ and `minetest.auth_reload` call the authetification handler.
* Convert a vector into a yaw (angle)
* `minetest.yaw_to_dir(yaw)`
* Convert yaw (angle) to a vector
+* `minetest.is_colored_paramtype(ptype)`
+ * Returns a boolean. Returns `true` if the given `paramtype2` contains color
+ information (`color`, `colorwallmounted` or `colorfacedir`).
+* `minetest.strip_param2_color(param2, paramtype2)`
+ * Removes everything but the color information from the
+ 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.
@@ -4275,6 +4297,7 @@ Definition tables
{
items = {"foo:bar", "baz:frob"}, -- Items to drop.
rarity = 1, -- Probability of dropping is 1 / rarity.
+ inherit_color = true, -- To inherit palette color from the node
},
},
},