tutorial:blockstate
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:blockstate [2021/07/23 18:02] – Fixed typos fireblast | tutorial:blockstate [2022/12/16 01:52] – solidblock | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Giving a block state ====== | ====== Giving a block state ====== | ||
- | Every type of block in Minecraft is represented by a singular '' | + | Every type of block in Minecraft is represented by a singular '' |
- | This makes it impossible to change a specific block' | + | |
- | as every other block of that type will be affected! | + | This is what '' |
- | But, what if you //do// want to give a singular block state, so it can change based on some condition? | + | |
- | This is what '' | + | |
- | 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 '' |
+ | |||
+ | In fact, you can also use existing properties defined in vanilla, which can be found in '' | ||
<code java> | <code java> | ||
- | public class MyBlock | + | public class ChargeableBlock |
public static final BooleanProperty CHARGED = BooleanProperty.of(" | public static final BooleanProperty CHARGED = BooleanProperty.of(" | ||
+ | | ||
+ | // The block instance. You can place it anywhere. Make the class is initialized. | ||
+ | public static final ChargeableBlock CHARGEABLE_BLOCK = new ChargeableBlock(FabricBlockSettings.copyOf(Blocks.STONE)); | ||
+ | } | ||
+ | </ | ||
+ | <code java> | ||
+ | public class ExampleMod implements ModInitializer { | ||
+ | @Override | ||
+ | public void onInitialize() { | ||
+ | Registry.register(Registries.BLOCK, | ||
+ | Registry.register(Registries.ITEM, | ||
+ | } | ||
} | } | ||
</ | </ | ||
Then we need to register the properties of the block by overriding '' | Then we need to register the properties of the block by overriding '' | ||
<code java> | <code java> | ||
- | public class MyBlock | + | public class ChargeableBlock |
[...] | [...] | ||
@Override | @Override | ||
- | protected void appendProperties(StateManager.Builder< | + | protected void appendProperties(StateManager.Builder< |
- | | + | |
} | } | ||
| | ||
Line 26: | Line 37: | ||
Then we need to set the default state of our property in the block constructor (To set multiple properties, chain '' | Then we need to set the default state of our property in the block constructor (To set multiple properties, chain '' | ||
<code java> | <code java> | ||
- | public class MyBlock | + | public class ChargeableBlock |
[...] | [...] | ||
- | public | + | public |
super(settings); | super(settings); | ||
- | setDefaultState(getStateManager().getDefaultState().with(CHARGED, | + | setDefaultState(getDefaultState().with(CHARGED, |
} | } | ||
| | ||
} | } | ||
</ | </ | ||
- | Now, we need to be able to charge the block, through the '' | + | Now, we need to be able to charge the block, through the '' |
<code java> | <code java> | ||
- | public class MyBlock | + | public class ChargeableBlock |
[...] | [...] | ||
@Override | @Override | ||
Line 48: | Line 59: | ||
</ | </ | ||
- | And Finally, to use the '' | + | And finally, to use the '' |
<code java> | <code java> | ||
- | public class MyBlock | + | public class ChargeableBlock |
[...] | [...] | ||
@Override | @Override | ||
public void onSteppedOn(World world, BlockPos pos, BlockState state, Entity entity) { | public void onSteppedOn(World world, BlockPos pos, BlockState state, Entity entity) { | ||
if (world.getBlockState(pos).get(CHARGED)){ | 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 = (LightningEntity) EntityType.LIGHTNING_BOLT.create(world); | ||
lightningEntity.refreshPositionAfterTeleport(Vec3d.ofBottomCenter(pos)); | lightningEntity.refreshPositionAfterTeleport(Vec3d.ofBottomCenter(pos)); | ||
Line 69: | Line 80: | ||
==== Adding models for your blockstates ==== | ==== Adding models 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 | + | 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 " |
- | Let's say you register an instance of '' | + | Let's say you register an instance of '' |
- | <code JavaScript resources/ | + | <code JavaScript resources/ |
{ | { | ||
" | " | ||
- | "": | + | "": |
} | } | ||
} | } | ||
Line 83: | Line 94: | ||
Let's break this simple example down. There are a couple important parts to this JSON: | Let's break this simple example down. There are a couple important parts to this JSON: | ||
- | - The ''" | + | * The '' |
- | - A variant named ''""'' | + | |
- | - The object assigned to the ''""'' | + | |
- | - The ''" | + | |
- | If you want to have different models for each blockstate, you should add multiple variants. For the same '' | + | If you want to have different models for each blockstate, you should add multiple variants. For the same '' |
- | <code JavaScript resources/ | + | <code JavaScript resources/ |
{ | { | ||
" | " | ||
- | " | + | " |
- | " | + | " |
} | } | ||
} | } | ||
Line 101: | Line 112: | ||
In this JSON, there are two variants, one for each possibility of the '' | In this JSON, there are two variants, one for each possibility of the '' | ||
- | 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 '' | + | 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 '' |
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:// | 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:// | ||
+ | |||
==== A note about performance ==== | ==== A note about performance ==== | ||
- | Every possible | + | Every possible |
+ | |||
+ | As all possible states have been built, an equal state for a block is a same object, and the '' |
tutorial/blockstate.txt · Last modified: 2024/08/26 01:19 by solidblock