User Tools

Site Tools


tutorial:itemgroup

Item Groups

Creating a simple Item Group

To have your ItemGroups properly show up in the creative menu, use the FabricItemGroupBuilder to create them:

  1. public class ExampleMod implements ModInitializer
  2. {
  3. // ...
  4. public static final ItemGroup ITEM_GROUP = FabricItemGroupBuilder.build(
  5. new Identifier("mod_id", "general"),
  6. () -> new ItemStack(Blocks.COBBLESTONE));
  7.  
  8. public static final ItemGroup OTHER_GROUP = FabricItemGroupBuilder.create(
  9. new Identifier("mod_id", "other"))
  10. .icon(() -> new ItemStack(Items.BOWL))
  11. .build();
  12. // ...
  13. }

Once FabricItemGroupBuilder#build is called, your group will be added to the list of item groups in the creative menu.

Make sure you replace the arguments 1) you pass to the Identifier constructor with your actual mod ID and the translation key you want to give your item group for localization 2) later on.

Adding your Items to your Item Group

To add an item to your item group, call Item.Settings#itemGroup when creating the item in the same way as adding it to a vanilla item group:

public static final Item YOUR_ITEM = new Item(new Item.Settings().itemGroup(ExampleMod.ITEM_GROUP));

Making an Item Group display specific Items in a particular order

Call FabricItemGroupBuilder#appendItems and pass any Consumer<List<ItemStack>>. You can then add whatever stacks you want to the given list in some order. ItemStack.EMPTY can be used to place empty spaces in your group.

  1. public class ExampleMod implements ModInitializer
  2. {
  3. // ...
  4. public static final ItemGroup ITEM_GROUP = FabricItemGroupBuilder.build(
  5. new Identifier("mod_id", "general"),
  6. () -> new ItemStack(Blocks.COBBLESTONE));
  7.  
  8. public static final ItemGroup OTHER_GROUP = FabricItemGroupBuilder.create(
  9. new Identifier("mod_id", "other"))
  10. .icon(() -> new ItemStack(Items.BOWL))
  11. .appendItems(stacks ->
  12. {
  13. stacks.add(new ItemStack(Blocks.BONE_BLOCK));
  14. stacks.add(new ItemStack(Items.APPLE));
  15. stacks.add(PotionUtil.setPotion(new ItemStack(Items.POTION), Potions.WATER));
  16. stacks.add(ItemStack.EMPTY);
  17. stacks.add(new ItemStack(Items.IRON_SHOVEL));
  18. })
  19. .build();
  20. // ...
  21. }

1)
Remember that the arguments you pass to the Identifier constructor can only contain certain characters.
Both arguments (the namespace & path) can contain lowercase letters, numbers, underscores, periods, or dashes. [a-z0-9_.-]
The second argument (the path) can also include slashes. [a-z0-9/._-]
Avoid using other symbols, else an InvalidIdentifierException would be thrown!
2)
The full translation key for the first example ItemGroup would be itemGroup.mod_id.general
tutorial/itemgroup.txt · Last modified: 2019/02/24 14:20 by virtuoel