| blob | d5a0b0632a8cd5b170779d11fb0318126965f1f3 |
1 ## Groups
2 This document explains all the groups used in this subgame.
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 * `dig_by_water=1`: Blocks with this group will drop when they are near flowing water
34 * `destroy_by_lava_flow=1`: Blocks with this group will be destroyed by flowing lava
35 * `dig_by_piston=1`: Blocks which will drop as an item when pushed by a piston. They also cannot be pulled by sticky pistons
36 * `cultivatable=2`: Block will be turned into Farmland by using a hoe on it
37 * `cultivatable=1`: Block will be turned into Dirt by using a hoe on it
38 * `flammable`: Block helps spreading fire and gets destroyed by nearby fire (rating doesn't matter)
39 * `spreading_dirt_type=1`: A dirt-type block with a cover (e.g. grass) which may spread to neighbor dirt blocks
40 * `dirtifies_below_solid=1`: This node turns into dirt immediately when a solid or dirtifier node is placed on top
41 * `dirtifier=1`: This node turns nodes the above group into dirt when placed above
42 * `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
43 * `soil=1`: Saplings and other small plants can grow on it
44 * `soil_sapling=2`: Soil for saplings. Intended to be natural soil. All saplings will grow on this
45 * `soil_sapling=1`: Artificial soil (such as farmland) for saplings. Some saplings will not grow on this
46 * `soil_sugarcane=1`: Sugar canes will grow on this near water
47 * `soil_nether_wart=1`: Nether wart will grow on this
48 * `enderman_takable=1`: Block can be taken and placed by endermen
49 * `disable_suffocation=1`: Disables suffocation for full solid cubes (1)
50 * `destroys_items=1`: If an item happens to be *inside* this node, the item will be destroyed
51 * `no_eat_delay=1`: Only for foodstuffs. When eating this, all eating delays are ignored.
52 * `can_eat_when_full=1`: Only for foodstuffs. This item can be eaten when the user has a full hunger bar
53 * `cauldron`: Cauldron. 1: Empty. 2-4: Water height
55 #### Footnotes
57 1. Normally, all walkable blocks with the default 1×1×1 cube as a collision box (e.g. sand,
58 gravel, stone, but not fences) will damage the players while their head is inside. This
59 is called “suffocation”. Setting this group disables this behaviour
61 ### Groups (mostly) used for crafting recipes
63 * `sand=1`: Sand (any color)
64 * `sandstone=1`: (Yellow) sandstone and related nodes (chiseled and the like) (only full blocks)
65 * `redsandstone=1`: Red sandstone and related nodes (chiseled and the like) (only full blocks)
66 * `quartz_block=1`: Quartz Block and variants (chiseled, pillar, etc.) (only full blocks)
67 * `stonebrick=1`: Stone Bricks and related nodes (only full blocks)
68 * `shulker_box=1`: Block is a shulker box
69 * `tree=1`: Oak Wood, Birch Wood, etc. (tree trunks)
70 * `wood=1`: Oak Wood Planks, Birch Wood Planks, etc. (only full blocks)
71 * `wood_slab=1`: Slabs made out of a kind of wooden planks
72 * `wood_stairs=1`: Stairs made out of a kind of wooden planks
73 * `coal=1`: Coal of any kind (lumps only, not blocks)
74 * `wool=1`: Wool (only full blocks)
75 * `carpet=1:` (Wool) carpet
76 * `stick=1`: Stick
77 * `water_bucket=1`: Bucket containing a liquid of group “water”
79 ### Material groups
81 These groups correspond to the Minecraft materials. They classify the block into a type, indicating what the block is “made off”.
83 * `material_stone=1`: Stone
84 * `material_wood=1`: Wood
85 * `material_sand=1`: Sand
86 * `material_glass=1`: Glass
88 Currently, these groups are used for the note block.
89 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.
91 ### Declarative groups
92 These groups are used mostly for informational purposes
94 * `solid=1`: Solid full-cube block (automatically assigned)
95 * `opaque=1`: Opaque block (automatically assigned)
96 * `not_solid=1`: Block is sold (only assign this group for nodes which are automatically detected as “solid” in error
97 * `fire=1`: Fire
98 * `water=1`: Water
99 * `lava=1`: Lava
100 * `torch`: Torch or torch-like node
101 * `torch=1`: Torch on floor
102 * `torch=2`: Torch at wall
103 * `liquid`: Block is a liquid
104 * `liquid=1`: Unspecified type
105 * `liquid=2`: Water
106 * `liquid=3`: Lava
107 * `fence=1`: Fence
108 * `fence_gate=1`: Fence gate
109 * `fence_wood=1`: Wooden fence
110 * `fence_nether_brick=1`: Nether brick fence
111 * `flower_pot`: Flower pot
112 * `flower_pot=1`: Empty flower pot
113 * `flower_pot=2`: Flower pot with a plant or flower
114 * `flower=1`: Flower
115 * `place_flowerlike=1`: Node has placement rules like that of a flower
116 * `place_flowerlike=2`: Node has placement rules like tall grass
117 * `cake`: Cake (rating = slices left)
118 * `book=1`: Book
119 * `pane=1`: Node is a “pane”-like node glass pane or iron bars
120 * `bed=1`: Bed
121 * `door=1`: Door
122 * `trapdoor=1`: Closed trapdoor
123 * `trapdoor=2`: Open trapdoor
124 * `glass=1`: Glass (full cubes only)
125 * `rail=1`: Rail
126 * `music_record`: Music Disc (rating is track ID)
127 * `tnt=1`: Block is TNT
128 * `boat=1`: Boat
129 * `minecart=1`: Minecart
130 * `food`: Item is a comestible item which can be consumed (healthy or unhealthy)
131 * `food=2`: Food
132 * `food=3`: Drink (including soups)
133 * `food=1`: Other/unsure
134 * `eatable`: Item can be *directly* eaten by wielding + right click (`on_use=item_eat`). Rating is the satiation gain
135 * `cocoa`: Node is a cocoa pod (rating is growth stage, ranging from 1 to 3)
136 * `ammo=1`: Item is used as ammo for a weapon
137 * `ammo_bow=1`: Item is used as ammo for bows
138 * `non_combat_armor=1`: Item can be equipped as armor, but is not made for combat (e.g. zombie head, pumpkin)
139 * `container`: Node is a container which physically stores items within and has at least 1 inventory
140 * `container=2`: Has one inventory with list name `"main"`. Items can be placed and taken freely
141 * `container=3`: Same as `container=2`, but shulker boxes can not be inserted
142 * `container=4`: Furnace-like, has lists `"src"`, `"fuel"` and `"dst"`.
143 It is expected that this also reacts on `on_timer`;
144 the node timer must be started from other mods when they add into `"src"` or `"fuel"`
145 * `container=5`: Left part of a 2-part horizontal connected container. Both parts have a `"main"` inventory
146 list. Both inventories are considered to belong together. This is used for large chests.
147 * `container=6`: Same as above, but for the right part.
148 * `container=1`: Other/unspecified container type
149 * `spawn_egg=1`: Spawn egg
151 * `pressure_plate=1`: Pressure plate (off)
152 * `pressure_plate=2`: Wooden pressure (on)
153 * `button=1`: Button (off)
154 * `button=2`: Button (on)
156 * `plant=1`: Plant or part of a plant
157 * `double_plant`: Part of a double-sized plant. 1 = lower part, 2 = upper part
159 * `weapon=1`: Item is primarily (!) a weapon
160 * `tool=1`: Item is primarily (!) a tool
161 * `craftitem=1`: Item is primarily (!) used for crafting
162 * `brewitem=1`: Item is primarily (!) used in brewing
163 * `transport=1`: Item is used for transportation
164 * `building_block=1`: Block is a building block
165 * `deco_block=1`: Block is a decorational block
167 ## Fake item groups
168 These groups put similar items together which should all be treated by the gameplay or the GUI as a single item.
169 You should not add custom items to these groups for no good reason, this is likely to cause a ton of conflicts.
171 * `clock`: Clock (rating indicates the “frame”)
172 * `compass`: Compass (rating indicates the “frame”)
174 This has the following implication: If you want to use a compass or clock in a crafting recipe, you *must*
175 use `group:compass` or `group:clock`, respectively.