Differences

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

--- tutorial:itemgroup [2019/09/18 10:32] – .group instead of .itemGroup yanis48
+++ tutorial:itemgroup [2024/08/23 13:03] (current) – solidblock
@@ Line 1: / Line 1: @@
+~~REDIRECT>https://docs.fabricmc.net/develop/items/custom-item-groups~~
 ====== Item Groups ======
-==== Creating a simple Item Group ====
-To have your ''ItemGroup'' properly show up in the creative menu, use the ''FabricItemGroupBuilder'' to create them:
+//This is the 1.20+ version of this tutorial. For the 1.19 version, see [[tutorial:1.19:itemgroup|Creating an itemgroup (1.19)]].//
-<code java [enable_line_numbers="true"]>
-public class ExampleMod implements ModInitializer
+So far, you have used ''/give @s tutorial:custom_item'' to obtain your item. However, unlike most vanilla items, it exists in none of the item group, and you cannot easily obtain it in Creative Mode! There are two ways of achieving this:
-{
+  * adding your item into an existing item group
-	// ...
+  * create your own item group and add items
-	public static final ItemGroup ITEM_GROUP = FabricItemGroupBuilder.build(
-		new Identifier("tutorial", "general"),
+All items added to any group will also be searchable within the creative inventory.
-		() -> new ItemStack(Blocks.COBBLESTONE));
+===== Add items into existing item groups =====
-	public static final ItemGroup OTHER_GROUP = FabricItemGroupBuilder.create(
-		new Identifier("tutorial", "other"))
+First, choose the item group that the item should be added to. For this example, that item group will be the building blocks group. The registry keys of vanilla item groups are stored in the ''<yarn class_7706>'' class.
-		.icon(() -> new ItemStack(Items.BOWL))
-		.build();
+Next, you will have to create an event handler for modifying item groups.
-	// ...
+<yarncode java [enable_line_numbers="true"]>
+public class ExampleMod implements ModInitializer {
+    @Override
+    public void onInitialize() {
+        ItemGroupEvents.modifyEntriesEvent(class_7706.field_40195).register(content -> {
+            content.add(TutorialItems.CUSTOM_ITEM);
+        });
+    }
 }
-</code>
+</yarncode>
-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 ((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!)) you pass to the ''Identifier'' constructor with your actual mod ID and the translation key you want to give your item group for localization ((The full translation key for the first example ''ItemGroup'' would be ''itemGroup.mod_id.general'')) later on.
+The modification event also allows more fine-grained control such as placing your custom item in a specific location(eg. after of ''<yarn field_8691>'') or other advanced modification, you can register the event handler for each item group that you would like to modify in your ''onInitialize'' method. Each item group that you would like to modify requires its own event handler, but the same event handler can be used to add multiple items to one item group.
-=== Adding your Items to your Item Group ===
+Items can be positioned relative to the existing vanilla items. Think carefully about where your mod's users would expect the item to be. For example, if you are adding a new type of wood, placing your item after the existing types of wood would make the most sense.
-When creating a custom Item, call ''Item.Settings#group'' on your settings and pass in your custom group:
-<code java>
-public static final Item YOUR_ITEM = new Item(new Item.Settings().group(ExampleMod.ITEM_GROUP));
-</code>
-==== Making an Item Group display specific Items in a particular order ====
+For example, this event handler will place your mod's item after the oak door in the building blocks item group:
-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.
-<code java [enable_line_numbers="true",highlight_lines_extra="11,12,13,14,15,16,17,18"]>
+<yarncode java [enable_line_numbers="true"]>
-public class ExampleMod implements ModInitializer
+public class ExampleMod implements ModInitializer {
-{
+    @Override
-	// ...
+    public void onInitialize() {
-	public static final ItemGroup ITEM_GROUP = FabricItemGroupBuilder.build(
+        ItemGroupEvents.modifyEntriesEvent(class_7706.field_40195).register(content -> {
-		new Identifier("tutorial", "general"),
+            content.addAfter(class_1802.field_8691, TutorialItems.CUSTOM_ITEM);
-		() -> new ItemStack(Blocks.COBBLESTONE));
+        });
+    }
-	public static final ItemGroup OTHER_GROUP = FabricItemGroupBuilder.create(
-		new Identifier("tutorial", "other"))
-		.icon(() -> new ItemStack(Items.BOWL))
-		.appendItems(stacks ->
-		{
-			stacks.add(new ItemStack(Blocks.BONE_BLOCK));
-			stacks.add(new ItemStack(Items.APPLE));
-			stacks.add(PotionUtil.setPotion(new ItemStack(Items.POTION), Potions.WATER));
-			stacks.add(ItemStack.EMPTY);
-			stacks.add(new ItemStack(Items.IRON_SHOVEL));
-		})
-		.build();
-	// ...
 }
-</code>
+</yarncode>
+In practice, considering items you register may be in large quantities, it's recommended to place then in a particular method, instead of directly in your ''ModInitializer''. See the following example (if write like this, remember to undo the codes above):
+<yarncode java [enable_line_numbers="true"]>
+public final class TutorialItems {
+    // [...]
+    public static void registerToVanillaItemGroups() {
+        ItemGroupEvents.modifyEntriesEvent(class_7706.field_40195).register(content -> {
+            content.addAfter(class_1802.field_8691, CUSTOM_ITEM);
+        });
+    }
+}
+</yarncode>
+Then, remember to refer to that method in your ''ModInitializer'':
+<yarncode java [enable_line_numbers="true"]>
+public class ExampleMod implements ModInitializer {
+    @Override
+    public void onInitialize() {
+        TutorialItems.registerToVanillaItemGroups();
+    }
+}
+</yarncode>
+===== Create your own item group =====
+Before you create an item group, determine whether it would have enough content to warrant its own group. Your item group will be placed on a separate page of tabs, impacting its discoverability, and users may be confused if the item is not where similar items are in the creative inventory.
+If you think that your own item group is needed, you can use the ''FabricItemGroup.builder'' method to create a builder for an item group. Make sure to call the ''build'' method as well:
+<yarncode java [enable_line_numbers="true"]>
+public final class TutorialItemGroups {
+    public static final class_1761 TEST_GROUP = FabricItemGroup.builder()
+        .icon(() -> new class_1799(TutorialItems.CUSTOM_ITEM))
+        .displayName(class_2561.method_43469("itemGroup.tutorial.test_group"))
+        .entries((context, entries) -> {
+            entries.add(TutorialItems.CUSTOM_ITEM);
+        })
+        .build();
+}
+</yarncode>
+You can add entries to your item group within the ''entries'' callback method. Note that unlike vanilla item groups, where you can add items relative to existing items, you must add items to your own item group in order since there are no vanilla items to position your items relative to.
+It is important to set the display name, otherwise it will cause a crash.
+The next step is to register your item group.
+<yarncode java [enable_line_numbers="true"]>
+public final class TutorialItemGroups {
+    // ....
+    public static void initialize() {
+        // Since 1.21:
+        class_2378.method_10230(class_7923.field_44687, Identifier.of("tutorial", "test_group"), ITEM_GROUP);
+        // Below 1.21:
+        class_2378.method_10230(class_7923.field_44687, new class_2960("tutorial", "test_group"), ITEM_GROUP);
+    }
+}
+</yarncode>
+Of course, you can directly register them when assigning the fields:
+<yarncode java [enable_line_numbers="true"]>
+public final class TutorialItemGroups {
+    public static final class_1761 TEST_GROUP = class_2378.method_10230(class_7923.field_44687, new class_2960("tutorial", "test_group"), FabricItemGroup.builder()
+        .icon(() -> new class_1799(CUSTOM_ITEM))
+        .displayName(class_2561.method_43469("itemGroup.tutorial.test_group"))
+        .entries((context, entries) -> {
+            entries.add(TutorialItems.CUSTOM_ITEM);
+        })
+        .build());
+    public static void initialize() {
+    }
+}
+</yarncode>
+Remember to statically load the class in your ''ModInitializer'':
+<yarncode java [enable_line_numbers="true"]>
+public class ExampleMod implements ModInitializer {
+    @Override
+    public void onInitialize() {
+        TutorialItemGroups.initialize();
+    }
+}
+</yarncode>
+:!: The screenshot below is outdated.
 {{:tutorial:item_group_append_items.png?nolink&400|}}