| blob | 1ac531b8ae5bfeb6e590cece5ed02dad6951add3 |
1 ## Groups
2 This document explains all the groups used in this game.
4 ### Special groups
6 * `not_in_creative_inventory=1`: Item will not be shown in creative inventory
7 * `not_in_craft_guide=1`: Item will not be shown as result or fuel item in crafting guide (but still may be shown as ingredient)
9 ### Digging time groups
11 The basic digging time groups determine by which tools a node can be dug.
13 * `pickaxey`: Diggable by pickaxe. The rating is for the possible tool materials in which the node will make its useful drop:
14 * `pickaxey=1`: Wood, gold, stone, iron and diamond
15 * `pickaxey=2`: Gold, stone, iron and diamond
16 * `pickaxey=3`: Stone, iron and diamond
17 * `pickaxey=4`: Iron and diamond
18 * `pickaxey=5`: Diamond
19 * `axey`: Axe. Rating is same as for `pickaxey`
20 * `shovely`: Shovel. Rating is same as for `pickaxey`
21 * `swordy=1`: Diggable by sword (any material), and this node is *not* a cobweb
22 * `swordy_cobweb=1`: Diggable by sword (any material), and this node is a cobweb
23 * `shearsy=1`: Diggable by shears, and this node is *not* wool
24 * `shearsy=wool=1`: Diggable by shears, and this node is wool
25 * `handy=1`: Breakable by hand and this node gives it useful drop when dug by hand. All nodes which are breakable by pickaxe, axe, shovel, sword or shears are also automatically breakable by hand, but not neccess
26 * `creative_breakable=1`: Block is breakable by hand in creative mode. This group is implied if the node belongs to any other digging group
28 Please read <http://minecraft.gamepedia.com/Breaking> to learn how digging times work in Minecraft, as MineClone 2 is based on the same system.
30 ### Groups for interactions
32 * `crush_after_fall=1`: For falling nodes. These will crush whatever they hit after falling, not dropping as an item
33 * `falling_node_damage=1`: For falling nodes. Hurts any objects it hits while falling. Damage is based on anvils
34 * `dig_by_water=1`: Blocks with this group will drop when they are near flowing water
35 * `destroy_by_lava_flow=1`: Blocks with this group will be destroyed by flowing lava
36 * `dig_by_piston=1`: Blocks which will drop as an item when pushed by a piston. They also cannot be pulled by sticky pistons
37 * `cultivatable=2`: Block will be turned into Farmland by using a hoe on it
38 * `cultivatable=1`: Block will be turned into Dirt by using a hoe on it
39 * `flammable`: Block spreads fire
40 * `flammable>0`: Gets destroyed by fire
41 * `flammable=-1` Does not get destroyed by fire
42 * `fire_encouragement`: How quickly this block catches fire
43 * `fire_flammability`: How fast the block will burn away
44 * `spreading_dirt_type=1`: A dirt-type block with a cover (e.g. grass) which may spread to neighbor dirt blocks
45 * `dirtifies_below_solid=1`: This node turns into dirt immediately when a solid or dirtifier node is placed on top
46 * `dirtifier=1`: This node turns nodes the above group into dirt when placed above
47 * `non_mycelium_plant=1`: A plant which can't grow on mycelium. Placing it on mycelium fails and if mycelium spreads below it, it uproots
48 * `soil=1`: Saplings and other small plants can grow on it
49 * `soil_sapling=2`: Soil for saplings. Intended to be natural soil. All saplings will grow on this
50 * `soil_sapling=1`: Artificial soil (such as farmland) for saplings. Some saplings will not grow on this
51 * `soil_sugarcane=1`: Sugar canes will grow on this near water
52 * `soil_nether_wart=1`: Nether wart will grow on this
53 * `enderman_takable=1`: Block can be taken and placed by endermen
54 * `disable_suffocation=1`: Disables suffocation for full solid cubes (1)
55 * `destroys_items=1`: If an item happens to be *inside* this node, the item will be destroyed
56 * `no_eat_delay=1`: Only for foodstuffs. When eating this, all eating delays are ignored.
57 * `can_eat_when_full=1`: Only for foodstuffs. This item can be eaten when the user has a full hunger bar
58 * `attached_node_facedir=1`: Like `attached_node`, but for facedir nodes
59 * `cauldron`: Cauldron. 1: Empty. 2-4: Water height
60 * `anvil`: Anvil. 1: No damage. 2-3: Higher damage levels
61 * `no_rename=1`: Item cannot be renamed by anvil
62 * `comparator_signal=X`: If set, this node outputs a constant (!) comparator signal output of strength X.
63 * `piston=X`: Piston (main body) (1 = normal, 2 = sticky)
64 * `piston_pusher=X`: Piston pusher (1 = normal, 2 = sticky)
65 * `hopper=X`: Hopper (1 = downwards, 2 = sideways)
66 * `portal=1`: Portal (node that teleports players and things by standing inside)
67 * `end_portal_frame=X`: End portal frame (1 = no eye, 2 = with eye)
68 * `coral=X`: Coral (any type) (1 = alive, 2 = dead)
69 * `coral_plant=X`: Coral in the "plant" shape (1 = alive, 2 = dead)
70 * `coral_fan=X`: Coral fan (1 = alive, 2 = dead)
71 * `coral_block=X`: Coral block (1 = alive, 2 = dead)
72 * `coral_species=X`: Specifies the species of a coral; equal X means equal species
74 #### Footnotes
76 1. Normally, all walkable blocks with the default 1×1×1 cube as a collision box (e.g. sand,
77 gravel, stone, but not fences) will damage the players while their head is inside. This
78 is called “suffocation”. Setting this group disables this behaviour
80 ### Groups (mostly) used for crafting recipes
82 * `sand=1`: Sand (any color)
83 * `sandstone=1`: Sandstone (any color) and related nodes (chiseled and the like) (only full blocks)
84 * `normal_sandstone=1`: “Normal” (yellow) sandstone and related nodes (chiseled and the like) (only full blocks)
85 * `red_sandstone=1`: Red sandstone and related nodes (chiseled and the like) (only full blocks)
86 * `hardened_clay=1`: Terracotta (any color)
87 * `quartz_block=1`: Quartz Block and variants (chiseled, pillar, etc.) (only full blocks)
88 * `stonebrick=1`: Stone Bricks and related nodes (only full blocks)
89 * `shulker_box=1`: Block is a shulker box
90 * `tree=1`: Oak Wood, Birch Wood, etc. (tree trunks)
91 * `wood=1`: Oak Wood Planks, Birch Wood Planks, etc. (only full blocks)
92 * `wood_slab=1`: Slabs made out of a kind of wooden planks
93 * `wood_stairs=1`: Stairs made out of a kind of wooden planks
94 * `coal=1`: Coal of any kind (lumps only, not blocks)
95 * `wool=1`: Wool (only full blocks)
96 * `carpet=1:` (Wool) carpet
97 * `stick=1`: Stick
98 * `water_bucket=1`: Bucket containing a liquid of group “water”
100 ### Material groups
102 These groups correspond to the Minecraft materials. They classify the block into a type, indicating what the block is “made off”.
104 * `material_stone=1`: Stone
105 * `material_wood=1`: Wood
106 * `material_sand=1`: Sand
107 * `material_glass=1`: Glass
109 Currently, these groups are used for the note block.
110 Note that not all Minecraft materials are used so far. More Minecraft materials will lilely only be added when they are needed for a concrete use case.
112 ### Declarative groups
113 These groups are used mostly for informational purposes
115 * `solid=1`: Solid full-cube block (automatically assigned)
116 * `opaque=1`: Opaque block (automatically assigned)
117 * `not_solid=1`: Block is not solid (only assign this group for nodes which are automatically detected as “solid” in error
118 * `not_opaque=1`: Block is not opaque (only assign this group for nodes which are automatically detected as “opaque” in error
119 * `fire=1`: Fire
120 * `water=1`: Water
121 * `lava=1`: Lava
122 * `top_snow=X`: Top snow with X layers (1-8)
123 * `torch`: Torch or torch-like node
124 * `torch=1`: Torch on floor
125 * `torch=2`: Torch at wall
126 * `liquid`: Block is a liquid
127 * `liquid=1`: Unspecified type
128 * `liquid=2`: Water
129 * `liquid=3`: Lava
130 * `fence=1`: Fence
131 * `fence_gate=1`: Fence gate
132 * `fence_wood=1`: Wooden fence
133 * `fence_nether_brick=1`: Nether brick fence
134 * `flower_pot`: Flower pot
135 * `flower_pot=1`: Empty flower pot
136 * `flower_pot=2`: Flower pot with a plant or flower
137 * `flower=1`: Flower
138 * `place_flowerlike=1`: Node has placement rules like that of a flower
139 * `place_flowerlike=2`: Node has placement rules like tall grass
140 * `cake`: Cake (rating = slices left)
141 * `book=1`: Book
142 * `pane=1`: Node is a “pane”-like node glass pane or iron bars
143 * `bed=1`: Bed
144 * `door=1`: Door
145 * `trapdoor=1`: Closed trapdoor
146 * `trapdoor=2`: Open trapdoor
147 * `glass=1`: Glass (full cubes only)
148 * `rail=1`: Rail
149 * `music_record`: Music Disc (rating is track ID)
150 * `tnt=1`: Block is TNT
151 * `boat=1`: Boat
152 * `minecart=1`: Minecart
153 * `food`: Item is a comestible item which can be consumed (healthy or unhealthy)
154 * `food=2`: Food
155 * `food=3`: Drink (including soups)
156 * `food=1`: Other/unsure
157 * `eatable`: Item can be *directly* eaten by wielding + right click (`on_use=item_eat`). Rating is the satiation gain
158 * `cocoa`: Node is a cocoa pod (rating is growth stage, ranging from 1 to 3)
159 * `ammo=1`: Item is used as ammo for a weapon
160 * `ammo_bow=1`: Item is used as ammo for bows
161 * `non_combat_armor=1`: Item can be equipped as armor, but is not made for combat (e.g. zombie head, pumpkin)
162 * `container`: Node is a container which physically stores items within and has at least 1 inventory
163 * `container=2`: Has one inventory with list name `"main"`. Items can be placed and taken freely
164 * `container=3`: Same as `container=2`, but shulker boxes can not be inserted
165 * `container=4`: Furnace-like, has lists `"src"`, `"fuel"` and `"dst"`.
166 It is expected that this also reacts on `on_timer`;
167 the node timer must be started from other mods when they add into `"src"` or `"fuel"`
168 * `container=5`: Left part of a 2-part horizontal connected container. Both parts have a `"main"` inventory
169 list. Both inventories are considered to belong together. This is used for large chests.
170 * `container=6`: Same as above, but for the right part.
171 * `container=7`: Has inventory list "`main`", no movement allowed
172 * `container=1`: Other/unspecified container type
173 * `spawn_egg=1`: Spawn egg
175 * `pressure_plate=1`: Pressure plate (off)
176 * `pressure_plate=2`: Wooden pressure (on)
177 * `button=1`: Button (off)
178 * `button=2`: Button (on)
179 * `redstone_torch=1`: Redstone Torch (lit)
180 * `redstone_torch=2`: Redstone Torch (unlit)
182 * `plant=1`: Plant or part of a plant
183 * `double_plant`: Part of a double-sized plant. 1 = lower part, 2 = upper part
185 * `pickaxe=1`: Pickaxe
186 * `shovel=1`: Shovel
187 * `axe=1`: Axe
188 * `sword=1`: Sword
189 * `hoe=1`: Hoe (farming tool)
190 * `shears=1`: Shears
192 * `weapon=1`: Item is primarily (!) a weapon
193 * `tool=1`: Item is primarily (!) a tool
194 * `craftitem=1`: Item is primarily (!) used for crafting
195 * `brewitem=1`: Item is primarily (!) used in brewing
196 * `transport=1`: Item is used for transportation
197 * `building_block=1`: Block is a building block
198 * `deco_block=1`: Block is a decorational block
200 ## Fake item groups
201 These groups put similar items together which should all be treated by the gameplay or the GUI as a single item.
202 You should not add custom items to these groups for no good reason, this is likely to cause a ton of conflicts.
204 * `clock`: Clock (rating indicates the “frame”)
205 * `compass`: Compass (rating indicates the “frame”)
207 This has the following implication: If you want to use a compass or clock in a crafting recipe, you *must*
208 use `group:compass` or `group:clock`, respectively.