Differences

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

--- tutorial:blockstate [2021/08/30 13:22] – [Adding models for your blockstates] solidblock
+++ tutorial:blockstate [2025/04/01 09:21] (current) – [Adding models and blockstates definitions for your blockstates] solidblock
@@ Line 1: / Line 1: @@
+~~REDIRECT>https://docs.fabricmc.net/develop/blocks/blockstates~~
 ====== 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 is what ''BlockState''s are for.
-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!
+===== Block state properties =====
-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.
+Each block can have zero, one or multiple **block state properties**. Each block state property can have at lease two values. Vanilla properties, can be found in ''Properties'' (''net.minecraft.state.property.Properties''). Obviously, many blocks are simple and they do not have block state properties, so their block states are sole.
+Several examples:
+  * [[directionalblock|Directional block]], the block state property used is ''Properties.HORIZONTAL_FACING'', whose value can be four horizontal directions
+  * [[waterloggable|Waterloggable block]], the block state property used is ''Properties.WATERLOGGED'', whose value can be true and false
+===== Custom block state property: a chargeable block as an example =====
 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.)
+If you intend to define other types of properties, you may use ''IntProperty'' or ''EnumProperty''.
+Create the class first:
 <code java>
-public class MyBlock extends Block {
+public class ChargeableBlock extends Block {
     public static final BooleanProperty CHARGED = BooleanProperty.of("charged");
+    public ChargeableBlock(Settings settings) {
+      super(settings);
+    }
+}
+</code>
+We register the blocks in the form described in [[blocks]].
+<code java>
+public final class TutorialBlocks {
+    // For versions below 1.21.2:
+    public static final ChargeableBlock CHARGEABLE_BLOCK = register("chargeable_block", new ChargeableBlock(Block.Settings.copy(Blocks.STONE)));
+    // For versions since 1.21.2:
+    public static final Block CHARGEABLE_BLOCK = register("chargeable_block", ChargeableBlock::new, Block.Settings.copy(Blocks.STONE));
+    // [...]
 }
 </code>
 Then we need to register the properties of the block by overriding ''appendProperties'', and then add the ''CHARGED'' property:
 <code java>
-public class MyBlock extends Block {
+public class ChargeableBlock extends Block {
     [...]
     @Override
-    protected void appendProperties(StateManager.Builder<Block, BlockState> stateManager) {
+    protected void appendProperties(StateManager.Builder<Block, BlockState> builder) {
-        stateManager.add(CHARGED);
+        builder.add(CHARGED);
     }
 }
 </code>
-Then we need to set the default state of our property in the block constructor (To set multiple properties, chain ''with()'' calls):
+Then we need to set the default state of our property. Go to the constructor of the class we created just now, and modify it like this:
 <code java>
-public class MyBlock extends Block {
+public class ChargeableBlock extends Block {
-    [...]
+    public ChargeableBlock(Settings settings) {
-    public MyBlock(Settings settings) {
         super(settings);
-        setDefaultState(getStateManager().getDefaultState().with(CHARGED, false));
+        setDefaultState(getDefaultState().with(CHARGED, false));
     }
 }
 </code>
-Now, we need to be able to charge the block, through the ''onUse'' function, with the ''world.setBlockState()'' function inside of it (The ''playSound'' is completely optional, but it helps us know that the block is charged).
+Now, we need to be able to charge the block, through the ''onUse'' method, with invoking the ''world.setBlockState()'' method inside of it (The ''playSound'' is completely optional, but it helps us know that the block is charged).
 <code java>
-public class MyBlock extends Block {
+public class ChargeableBlock extends Block {
     [...]
     @Override
-    public ActionResult onUse(BlockState state, World world, BlockPos pos, PlayerEntity player, Hand hand, BlockHitResult hit) {
+    public ActionResult onUse(BlockState state, World world, BlockPos pos, PlayerEntity player, BlockHitResult hit) {
         player.playSound(SoundEvents.BLOCK_RESPAWN_ANCHOR_CHARGE, 1, 1);
         world.setBlockState(pos, state.with(CHARGED, true));
@@ Line 48: / Line 78: @@
 </code>
-And Finally, to use the ''CHARGED'' property, we call ''onSteppedOn'', with ''world.getBlockState(pos).get(CHARGED)'' inside of it:
+And finally, to use the ''CHARGED'' property, we call ''onSteppedOn'', with ''world.getBlockState(pos).get(CHARGED)'' inside of it:
 <code java>
-public class MyBlock extends Block {
+public class ChargeableBlock extends Block {
     [...]
     @Override
     public void onSteppedOn(World world, BlockPos pos, BlockState state, Entity entity) {
         if (world.getBlockState(pos).get(CHARGED)){
-            //Summoning the Lighting Bolt at the block
+            // Summoning the Lighting Bolt at the block
-            LightningEntity lightningEntity = (LightningEntity) EntityType.LIGHTNING_BOLT.create(world);
+            LightningEntity lightningEntity = EntityType.LIGHTNING_BOLT.create(world, SpawnReason.MOB_SUMMONED);
             lightningEntity.refreshPositionAfterTeleport(Vec3d.ofBottomCenter(pos));
             world.spawnEntity(lightningEntity);
@@ Line 67: / Line 97: @@
 </code>
-==== Adding models for your blockstates ====
+==== Adding models and blockstates definitions for your blockstates ====
-You can also make the texture and model of your block change based on the state. This is done through a JSON file called a Blockstate JSON. All blocks need a blockstate JSON, whether they have multiple states or not, but the contents of the JSON can be as simple or complex as you like. If you want to change the textures of your block based on the state, you //will// need multiple models.
+You can also make the texture and model of your block change based on the state. This is done through a JSON file called a "**block states definition**". All blocks need a blockstates definition, whether they have multiple states or not, but the contents of it can be as simple or complex as you like. If you want to change the textures of your block based on the state, you //will// need multiple models.
-Let's say you register an instance of ''MyBlock'' to the ID ''mymod:my_block''. Minecraft would look for a file at the location ''src/main/resources/assets/mymod/blockstates/my_block.json'' to load the state from. If you don't want your block to change models between states, the blockstate JSON can be very simple. It would look something like this:
+Let's say you register an instance of ''Chargeable'' to the ID ''tutorial:chargeable_block''. Minecraft would look for a file at the location ''src/main/resources/assets/tutorial/blockstates/chargeable_block.json'' to load the state from. If you don't want your block to change models between states, the blockstates definition can be very simple. It would look something like this:
-<code JavaScript resources/assets/mymod/blockstates/my_block.json>
+<code JavaScript resources/assets/tutorial/blockstates/chargeable_block.json>
 {
     "variants": {
-        "": { "model": "mymod:block/my_block" }
+        "": { "model": "tutorial:block/chargeable_block" }
     }
 }
@@ Line 83: / Line 113: @@
 Let's break this simple example down. There are a couple important parts to this JSON:
-  * The ''"variants"'' block will be where all possible variations for your blockstate go. We'll explore variants more in a little.
+  * The ''%%"variants"%%'' defines what model should each possible blockstate use. We'll explore variants more in a little.
-  * A variant named ''""'' will apply to //every// permutation of a blockstate. If you have a ''""'' variant, you shouldn't have any other variants in the JSON, or Minecraft will get upset.
+  * A variant named ''%%""%%'' (empty string) will apply to //every// permutation of a blockstate. If you have a ''%%""%%'' variant, you shouldn't have any other variants in the JSON, or Minecraft will get upset.
-  * The object assigned to the ''""'' variant can have various properties added to it like rotation or texture manipulation. Check out the linked Model page below for more documentation on what properties can be added. All variants //must// contain a ''"model"'' property.
+  * The object assigned to the ''%%""%%'' variant can have various properties added to it like rotation or texture manipulation. Check out the linked Model page below for more documentation on what properties can be added. All variants //must// contain a ''%%"model"%%'' property.
-  * The ''"model"'' property is always passed an ID of a model. In this case, the game will look at the location ''src/main/resources/assets/mymod/models/block/my_block.json''. The ID here can be anything. It doesn't //need// to be the same as your block's ID, but if you only have one variant, it probably should. Block models have their own setup, which is documented very well on the Minecraft wiki page linked below. You can either write the JSON by hand or use a program like [[https://blockbench.net|Blockbench]] to generate it more easily.
+  * The ''%%"model"%%'' property is always passed an ID of a model. In this case, the game will look at the location ''src/main/resources/assets/tutorial/models/block/chargeable_block.json''. The ID here can be anything. It doesn't //need// to be the same as your block's ID, but if you only have one variant, it probably should. Block models have their own setup, which is documented very well on the Minecraft wiki page linked below. You can either write the JSON by hand or use a program like [[https://blockbench.net|Blockbench]] to generate it more easily.
-If you want to have different models for each blockstate, you should add multiple variants. For the same ''src/main/resources/assets/mymod/blockstates/my_block.json'' location we used above, your model file would probably look like such:
+If you want to have different models for each blockstate, you should add multiple variants. For the same ''src/main/resources/assets/tutorial/blockstates/chargeable_block.json'' location we used above, your model file would probably look like such:
-<code JavaScript resources/assets/mymod/blockstates/my_block.json>
+<code JavaScript resources/assets/tutorial/blockstates/chargeable_block.json>
 {
     "variants": {
-        "charged=false": { "model": "mymod:block/my_block" },
+        "charged=false": { "model": "tutorial:block/chargeable_block" },
-        "charged=true": { "model": "mymod:block/my_block_charged" }
+        "charged=true": { "model": "tutorial:block/chargeable_block_charged" }
     }
 }
 </code>
-In this JSON, there are two variants, one for each possibility of the ''CHARGED'' property we defined above. Since we gave the property the string name of ''charged'' in the Java, that's what we use here. Booleans only have two states, but if you use properties based on integers or enums, you'll have more variants.
+In this blockstates definition, there are two variants, one for each possibility of the ''CHARGED'' property we defined above. Since we gave the property the string name of ''charged'' in the Java, that's what we use here. Booleans only have two states, but if you use properties based on integers or enums, you'll have more variants.
-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 ''mymod:my_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.
+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 blockstates definitions. You can visit Minecraft Wiki for all of the tricks you can do with [[https://minecraft.wiki/Model|models]] and [[https://minecraft.wiki/Blockstates_definition|blockstates definitions]], along with examples of how the features are used in vanilla. You can also [[datagen_model|generate models with data generator]]. 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.gamepedia.com/Model|Minecraft wiki]], 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''.