From: Perttu Ahola <celeron55@gmail.com>
Date: Fri, 9 Mar 2012 23:57:59 +0000 (+0200)
Subject: Add a small bunch of notes about groups in mods/default/init.lua
X-Git-Tag: 0.4.dev-20120318~84
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=fa70413c82c78a9624c7d2af5d9c33e12fcde745;p=oweals%2Fminetest.git

Add a small bunch of notes about groups in mods/default/init.lua
---

diff --git a/data/mods/default/init.lua b/data/mods/default/init.lua
index c37f0e815..09648699d 100644
--- a/data/mods/default/init.lua
+++ b/data/mods/default/init.lua
@@ -429,6 +429,18 @@
 --     chance = 1, -- (chance of trigger is 1.0/this)
 --     action = func(pos, node, active_object_count, active_object_count_wider),
 -- }
+--
+-- Item groups:
+-- - Groups always have a rating associated with them. If there is no
+--   useful meaning for a rating for a given group, it shall be 1.
+-- - When not defined, the rating of a group defaults to 0.
+--
+-- Special groups:
+-- - dig_immediate:
+--   - 2: node is removed without tool wear after 1 second or so
+--   - 3: node is removed without tool wear immediately (like a torch)
+-- - level: Can be used to give an additional sense of progression in the game.
+--   - 0 is something that is directly accessible at the start of gameplay
 
 WATER_ALPHA = 160
 WATER_VISC = 1