Differences

This shows you the differences between two versions of the page.

--- tutorial:blockstate [2022/03/20 14:01] – [Adding models for your blockstates] solidblock
+++ tutorial:blockstate [2023/11/18 08:13] (current) – [Adding models for your blockstates] update Minecraft Wiki link solidblock
@@ Line 1: / Line 1: @@
 ====== Giving a block state ======
-Every type of block in Minecraft is represented by a singular ''Block'' instance.
+Every type of block in Minecraft is represented by a singular ''Block'' instance. This makes it impossible to change a specific block's state by simply changing the ''Block'' instance's state, as every other block of that type will be affected! But, what if you //do// want to give a singular block state, so it can change based on some condition?
-This makes it impossible to change a specific block's state by simply changing the ''Block'' instance's state,
-as every other block of that type will be affected!
+This is what ''BlockState''s are for. Say we wanted a block that can summon lightning, but only when charged up.
-But, what if you //do// want to give a singular block state, so it can change based on some condition?
-This is what ''BlockState''s are for.
-Say we wanted a block that can summon lightning, but only when charged up.
-First we define the boolean property of the block - whether or not it is charged (careful not to import the wrong BooleanProperty!):
+First we define the boolean property of the block - whether or not it is charged (careful not to import the wrong ''BooleanProperty''), and register the block within the mod initializer. (If you directly register the block in the static field in the ''ChargeableBlock'' class, the mod initializer may totally ignore it if the class is not initialized.)
+In fact, you can also use existing properties defined in vanilla, which can be found in ''Properties'' (''net.minecraft.state.property.Properties''). If you intend to define other types of properties, you may use ''IntProperty'' or ''EnumProperty''.
 <code java>
 public class ChargeableBlock extends Block {
     public static final BooleanProperty CHARGED = BooleanProperty.of("charged");
-    // The block instance. You can place it anywhere.
+    // The block instance. You can place it anywhere. Make the class is initialized.
-    public static final ChargeableBlock CHARGEABLE_BLOCK = Registry.register(
+    public static final ChargeableBlock CHARGEABLE_BLOCK = new ChargeableBlock(FabricBlockSettings.copyOf(Blocks.STONE));
-        Registry.BLOCK,
+}
-        new Identifier("tutorial", "chargeable_block"),
+</code>
-        new ChargeableBlock( /* write anything appropriate here */ ));
+<code java>
+public class ExampleMod implements ModInitializer {
+    @Override
+    public void onInitialize() {
+        Registry.register(Registries.BLOCK, new Identifier("tutorial", "chargeable_block"), ChargeableBlock.CHARGEABLE_BLOCK);
+        Registry.register(Registries.ITEM, new Identifier("tutorial", "chargeable_block"), new BlockItem(ChargeableBlock.CHARGEABLE_BLOCK, new FabricItemSettings());
+    }
 }
 </code>
@@ Line 36: / Line 41: @@
     public ChargeableBlock(Settings settings) {
         super(settings);
-        setDefaultState(getStateManager().getDefaultState().with(CHARGED, false));
+        setDefaultState(getDefaultState().with(CHARGED, false));
     }
@@ Line 109: / Line 114: @@
 Variants are based on possible permutations of the properties added to your block. A property can be totally ignored in the blockstate JSON if you want, like in the first blockstate JSON where we ignored the ''charged'' property, but if you want to include a property in one variant, it must be included in //all// variants. If ''tutorial:chargeable_block'' also had a boolean property called ''glowing'', and you wanted to change the model based on whether it was glowing and based on whether it was charged, you would need four variants: charged off and glowing off, charged on and glowing off, charged off and glowing on, and charged on and glowing on. The same model can be assigned to multiple variants if you need it to be.
-This is only a simple introduction to blockstate JSONs. All of the tricks you can do with blockstate and model JSONs are documented on the [[https://minecraft.gamepedia.com/Model|Minecraft wiki]], along with examples of how the features are used in vanilla. Best of luck!
+This is only a simple introduction to blockstate JSONs. All of the tricks you can do with blockstate and model JSONs are documented on the [[https://minecraft.wiki/Model|Minecraft wiki page]], along with examples of how the features are used in vanilla. Best of luck!
 ==== A note about performance ====
-Every possible state of a block is registered at the start of the game. This means that if you have 14 boolean properties, the block has 2^14 = 16384 different states and 2^14 states are registered. For this reason blocks should not contain too many blockstate properties. Rather, blockstates should be mostly reserved for visuals, and [[tutorial:blockentity|Block Entities]] should be used for more advanced state.
+Every possible blockstate for a block is registered when the ''Block'' object is initialized. This means that if you have 14 boolean properties, the block has 2^14 = 16384 different states and 2^14 states are registered. For this reason, blocks should not contain too many blockstate properties. Rather, blockstates should be mostly reserved for visuals, and [[tutorial:blockentity|Block Entities]] should be used for more advanced state.
+As all possible states have been built, an equal state for a block is a same object, and the ''with'' method returns an existing object, instead of creating a new object - which means, for example, ''CHARGEABLE_BLOCK.getDefaultState().with(CHARGED, true) == CHARGEABLE_BLOCK.getDefaultState().with(CHARGED, true)'' returns ''true''.