tutorial:blocks
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:blocks [2020/01/04 16:04] – [Next Steps] Classes? jamieswhiteshirt | tutorial:blocks [2023/10/23 09:29] – Fix typo mattidragon | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Adding a Block ====== | ====== Adding a Block ====== | ||
- | ==== Introduction ==== | + | Adding blocks to your mod follows a similar process to [[tutorial: |
- | To add a block to your mod, you will need to register a new instance of the Block class. For more control over your block, you can create a custom block class. We'll also look at adding | + | ===== Creating |
- | ==== Creating | + | |
+ | Start by creating an instance of '' | ||
- | To start, create an instance of Block in your main mod class. Block' | ||
<code java [enable_line_numbers=" | <code java [enable_line_numbers=" | ||
- | public class ExampleMod implements ModInitializer | + | public class ExampleMod implements ModInitializer { |
- | { | + | |
- | // an instance | + | /* Declare and initialize our custom block instance. |
- | public static final Block EXAMPLE_BLOCK = new Block(FabricBlockSettings.of(Material.METAL).build()); | + | We set our block material to `METAL`. |
- | | + | |
+ | | ||
+ | | ||
+ | Stone has a hardness of 1.5f and a resistance of 6.0f, while Obsidian has a hardness of 50.0f and a resistance of 1200.0f. | ||
+ | |||
+ | You can find the stats of all vanilla blocks in the class `Blocks`, where you can also reference other blocks. | ||
+ | | ||
+ | // public static final Block EXAMPLE_BLOCK = new Block(FabricBlockSettings.of(Material.METAL).strength(4.0f)); // fabric api version <= 0.77.0 | ||
+ | | ||
+ | @Override | ||
+ | public void onInitialize() { | ||
+ | |||
+ | } | ||
} | } | ||
</ | </ | ||
- | ==== Registering | + | ==== Registering |
- | Registering blocks is the same as registering items. Call //Registry.register// | + | Blocks should be registered under the '' |
- | <code java [enable_line_numbers=" | + | If you're using version 1.19.2 or below, please replace '' |
- | public class ExampleMod implements ModInitializer | + | |
- | { | + | <code java [enable_line_numbers=" |
- | // block creation | + | public class ExampleMod implements ModInitializer { |
- | | + | |
+ | // public static final Block EXAMPLE_BLOCK = new Block(FabricBlockSettings.of(Material.METAL).strength(4.0f)); | ||
+ | | ||
| | ||
@Override | @Override | ||
- | public void onInitialize() | + | public void onInitialize() { |
- | | + | Registry.register(Registries.BLOCK, new Identifier(" |
- | Registry.register(Registry.BLOCK, new Identifier(" | + | |
} | } | ||
} | } | ||
</ | </ | ||
- | Your block will //not// be accessible as an item, but it can be seen in-game by using ''/ | + | Your custom |
- | ==== Registering | + | ==== Registering |
- | In most cases, you want to be able to place your block using an item. To do this, you need to register a corresponding BlockItem in the item registry. You can do this by registering an instance of BlockItem under Registry.ITEM. The registry name of the item should usually be the same as the registry name of the block. | + | In most cases, you want to be able to place your block using an item. To do this, you need to register a corresponding BlockItem in the item registry. You can do this by registering an instance of BlockItem under '' |
- | <code java [enable_line_numbers=" | + | <code java [enable_line_numbers=" |
- | public class ExampleMod implements ModInitializer | + | public class ExampleMod implements ModInitializer { |
- | { | + | |
- | // block creation | + | // public static final Block EXAMPLE_BLOCK = new Block(FabricBlockSettings.of(Material.METAL).strength(4.0f)); |
- | | + | |
| | ||
@Override | @Override | ||
- | public void onInitialize() | + | public void onInitialize() { |
- | | + | |
- | | + | Registry.register(Registries.ITEM, new Identifier(" |
- | [...] | + | |
- | | + | |
- | Registry.register(Registry.ITEM, new Identifier(" | + | |
} | } | ||
} | } | ||
</ | </ | ||
- | ==== Giving your block a model ==== | + | ===== Giving your Block Visuals ===== |
- | As you probably have noticed, the block is simply | + | At this point, your new block will appear as a purple and black checkerboard pattern in-game. This is Minecraft' |
+ | * A blockstate file | ||
+ | * A block model file | ||
+ | * A texture | ||
+ | * An item model file (if the block has an item associated with it). | ||
+ | |||
+ | The files should be located here: | ||
Blockstate: src/ | Blockstate: src/ | ||
Line 66: | Line 82: | ||
Block Texture: src/ | Block Texture: src/ | ||
- | The blockstate file determines which model that the block should use depending on it' | + | The blockstate file determines which model a block should use depending on its blockstate. |
<code JavaScript src/ | <code JavaScript src/ | ||
Line 76: | Line 92: | ||
</ | </ | ||
- | The block model file defines the shape and texture of your block. | + | The block model file defines the shape and texture of your block. |
<code JavaScript src/ | <code JavaScript src/ | ||
Line 87: | Line 103: | ||
</ | </ | ||
- | In most cases you want the block to look the same in hand. To do this, you can make an item file that inherits from the block model file: | + | In most cases, you will want the block to look the same in item form. You can make an item model that has the block model file as a parent, which makes it appear exactly like the block: |
<code JavaScript src/ | <code JavaScript src/ | ||
Line 95: | Line 111: | ||
</ | </ | ||
- | Load up Minecraft and your block should | + | Load up Minecraft and your block should have visuals! |
- | ==== Adding a block loot table ==== | + | ===== Configuring Block Drops ===== |
- | The block must have a loot table for any items to drop when the block is broken. Assuming | + | To make your block drop items when broken, you will need a //loot table//. The following file will cause your block to drop its respective item form when broken: |
<code JavaScript src/ | <code JavaScript src/ | ||
Line 123: | Line 139: | ||
</ | </ | ||
- | When broken in survival mode, the block will now drop an item. | + | In minecraft 1.17, there has been a change for breaking blocks. Now, to define harvest tools and harvest levels, we need to use tags. Read about tags at: [[tutorial: |
- | ==== Creating a Block class ==== | + | Harvest tool: src/main/resources/data/minecraft/ |
- | When creating a simple block the above approach works well, but sometimes you want a //special// block with unique mechanics. We'll create a separate class that extends Block to do this. The class needs a constructor that takes in a BlockSettings argument. | + | Harvest level: src/ |
- | < | + | < |
- | public class ExampleBlock extends Block | + | |
{ | { | ||
- | | + | " |
- | { | + | " |
+ | " | ||
+ | ] | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | <code JavaScript src/ | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ] | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | For the harvest level tags (needs_stone_tool, | ||
+ | |||
+ | |||
+ | <code java [enable_line_numbers=" | ||
+ | // public | ||
+ | | ||
+ | </ | ||
+ | |||
+ | ===== Creating a Custom Block Class ===== | ||
+ | |||
+ | The above approach works well for simple blocks but falls short when you want a block with //unique// mechanics. We'll create a // | ||
+ | |||
+ | <code java [enable_line_numbers=" | ||
+ | public class ExampleBlock extends Block { | ||
+ | |||
+ | public ExampleBlock(Settings settings) | ||
super(settings); | super(settings); | ||
} | } | ||
Line 138: | Line 183: | ||
</ | </ | ||
- | Just like we did in the item tutorial, you can override methods in the block class for custom functionality. | + | You can override methods in the block class for custom functionality. |
- | <code java> | + | <code java [enable_line_numbers=" |
- | | + | public class ExampleBlock extends Block { |
- | public | + | |
- | | + | public |
+ | | ||
} | } | ||
- | </ | ||
- | To add this block into the game, replace //new Block// with //new ExampleBlock// | + | @Override |
+ | public ActionResult onUse(BlockState state, World world, BlockPos pos, PlayerEntity player, Hand hand, BlockHitResult hit) { | ||
+ | if (!world.isClient) { | ||
+ | player.sendMessage(Text.of(" | ||
+ | } | ||
- | <code java [enable_line_numbers=" | + | return ActionResult.SUCCESS; |
- | public class ExampleMod implements ModInitializer | + | |
- | { | + | |
- | // an instance of our new item | + | |
- | public static final ExampleBlock EXAMPLE_BLOCK = new ExampleBlock(Block.Settings.of(Material.STONE)); | + | |
- | | + | |
} | } | ||
</ | </ | ||
- | Your custom block should now be transparent! | + | To use your custom block class, replace '' |
+ | <code java [enable_line_numbers=" | ||
+ | public class ExampleMod implements ModInitializer { | ||
- | ==== Custom VoxelShape ==== | + | // public static final Block EXAMPLE_BLOCK |
+ | public static final Block EXAMPLE_BLOCK | ||
+ | |||
+ | @Override | ||
+ | public void onInitialize() { | ||
+ | Registry.register(Registries.BLOCK, | ||
+ | Registry.register(Registries.ITEM, | ||
+ | } | ||
+ | } | ||
+ | </ | ||
- | When making custom blocks which do not entirely fill the block, the adjacent blocks might hide their faces. In this case of a custom vertical slab it would look like this: | + | ==== Custom Shape==== |
+ | |||
+ | When using block models that do not //entirely// fill the block (eg. Anvil, Slab, Stairs), while its voxel shape is full, the hidden | ||
{{: | {{: | ||
+ | To fix this, we have to define the '' | ||
- | We have to define the VoxelShape of the new block into one which is not an entire block: | + | < |
- | + | public class ExampleBlock extends Block { | |
- | < | + | [...] |
- | @Override | + | |
- | | + | public VoxelShape getOutlineShape(BlockState state, BlockView view, BlockPos pos, ShapeContext context) { |
- | | + | return VoxelShapes.cuboid(0f, |
- | } | + | } |
+ | } | ||
</ | </ | ||
- | By doing so we also define getCollisionShape, | + | Note that the //collision shape// |
{{: | {{: | ||
- | ==== Next Steps ==== | + | ===== Next Steps ===== |
[[tutorial: | [[tutorial: | ||
[[tutorial: | [[tutorial: | ||
+ | |||
+ | To make your block flammable (that is, can be burned in fire), you may use '' |
tutorial/blocks.txt · Last modified: 2024/04/15 01:52 by solidblock