Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:datagen_advancements

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:datagen_advancements [2022/12/24 00:50] – Made explicit where the criterion needs to be registered. jmanc3tutorial:datagen_advancements [2023/10/02 23:11] (current) – Updated custom criterion section jmanc3
Line 5: Line 5:
 ==== Before continuing ==== ==== Before continuing ====
  
-Make sure you've to read the first section of the [[datagen_setup|Getting started with Data Generation]] page, have a class that implements ''DataGenerationEntrypoint'', and know about the gradle task that needs to be called after any change in our data generators.+Make sure you've to read the first section of the [[datagen_setup|Getting started with Data Generation]] page, have a class that implements ''**DataGeneratorEntrypoint**'', and know about the gradle task that needs to be called after any change in our data generators.
  
 ===== Hooking Up the Provider ===== ===== Hooking Up the Provider =====
  
-To begin making custom advancements, we need to hook up an advancement generator to the general data generator. +To begin making custom advancements, we need to hook up an advancement generator to the class which ''**implements DataGeneratorEntrypoint**'' as follows:
  
-Unfortunately there's like three layers of indirection before we can actually start adding some advancements, but we'll go one layer at a time. First things first, in the ''DataGeneration'' file we created earlier, add the following: +<code java>
- +
-<code java [highlight_lines_extra="11"]>+
 import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint; import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint;
 import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator; import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator;
 +import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput;
 +import net.fabricmc.fabric.api.datagen.v1.provider.FabricAdvancementProvider;
 +import net.minecraft.advancement.*;
 +import java.util.function.Consumer;
  
-public class DataGeneration implements DataGeneratorEntrypoint {+public class ExampleModDataGenerator implements DataGeneratorEntrypoint {
  
     @Override     @Override
     public void onInitializeDataGenerator(FabricDataGenerator generator) {     public void onInitializeDataGenerator(FabricDataGenerator generator) {
-        /**  +        FabricDataGenerator.Pack pack = generator.createPack();
-        /* Add our advancements generator +
-         **/ +
-        generator.createPack().addProvider(AdvancementsProvider::new);+
  
-        // .. (Your other generators)+        pack.addProvider(AdvancementsProvider::new);
     }     }
-} 
-</code> 
  
-  * It should be noted that the ''DataGeneration'' class we're making is actually not specific to advancements. It is a more general class that is the starting point for [[datagen_loot|loot table generation]], [[datagen_model|model generation]], [[datagen_tags|tag generation]], [[datagen_recipe|recipe generation]], and [[datagen_language|language generation]].+    static class AdvancementsProvider extends FabricAdvancementProvider { 
 +        protected AdvancementsProvider(FabricDataOutput dataGenerator) { 
 +            super(dataGenerator); 
 +        }
  
-We passed the ''addProvider'' function a class (''AdvancementsProvider'') that we haven't made yet, so let's make it. Add a new class ''AdvancementsProvider'' which extends ''FabricAdvancementProvider'' as follows: +        @Override 
- +        public void generateAdvancement(Consumer<AdvancementEntry> consumer) { 
-<code java [highlight_lines_extra="14"]> +            //  
-import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput; +            // We will create our custom advancements here... 
-import net.fabricmc.fabric.api.datagen.v1.provider.FabricAdvancementProvider; +            // 
-import net.minecraft.advancement.Advancement; +        }
- +
-import java.util.function.Consumer; +
- +
-public class AdvancementsProvider extends FabricAdvancementProvider { +
-    protected AdvancementsProvider(FabricDataOutput dataGenerator) { +
-        super(dataGenerator); +
-    } +
- +
-    @Override +
-    public void generateAdvancement(Consumer<Advancement> consumer) { +
-        new Advancements().accept(consumer);+
     }     }
 } }
 </code> </code>
  
-You'll once again notice on the highlighted line that we have another class we haven't created yet. +  * It should be noted that the ''**ExampleModDataGenerator**'' class is not specific to advancements. It is also the starting point for [[datagen_loot|loot table generation]], [[datagen_model|model generation]], [[datagen_tags|tag generation]], [[datagen_recipe|recipe generation]], and [[datagen_language|language generation]].
- +
-Here's how the ''Advancements'' class should look, and where we will finally begin writing some custom advancements. +
- +
-<code java> +
-import net.minecraft.advancement.Advancement; +
- +
-import java.util.function.Consumer; +
- +
-public class Advancements implements Consumer<Consumer<Advancement>> { +
- +
-    @Override +
-    public void accept(Consumer<Advancement> consumer) { +
-        //  +
-        // We will create our custom advancements here... +
-        // +
-    } +
-} +
-</code>+
  
 ===== Simple Advancement ===== ===== Simple Advancement =====
  
-Let's start simple and work our way up to custom criterions. We'll start with an advancement that activates after you pick up your first dirt block, and we're going to add it to our ''Advancements'' class.+Let's start simple and work our way up to custom criterions. We'll start with an advancement that activates after you pick up your first dirt block, and we're going to add it to the function ''**generateAdvancement**'' inside the ''**AdvancementsProvider**'' class we just wrote.
  
 <code java> <code java>
-import net.minecraft.advancement.Advancement; +// ... (Previous imports)
-import net.minecraft.advancement.AdvancementFrame;+
 import net.minecraft.advancement.criterion.InventoryChangedCriterion; import net.minecraft.advancement.criterion.InventoryChangedCriterion;
 import net.minecraft.item.Items; import net.minecraft.item.Items;
Line 86: Line 56:
 import net.minecraft.util.Identifier; import net.minecraft.util.Identifier;
  
-import java.util.function.Consumer;+public class ExampleModDataGenerator implements DataGeneratorEntrypoint {
  
-public class Advancements implements Consumer<Consumer<Advancement>> {+    // ... (Rest of the code)
  
-    @Override +    static class AdvancementsProvider extends FabricAdvancementProvider { 
-    public void accept(Consumer<Advancement> consumer) { + 
-        Advancement rootAdvancement = Advancement.Builder.create() +        // ... (Rest of the code) 
-                .display( + 
-                        Items.DIRT, // The display icon +        @Override 
-                        Text.literal("Your First Dirt Block"), // The title +        public void generateAdvancement(Consumer<AdvancementEntry> consumer) { 
-                        Text.literal("Now make a three by three"), // The description +            AdvancementEntry rootAdvancement = Advancement.Builder.create() 
-                        new Identifier("textures/gui/advancements/backgrounds/adventure.png"), // Background image used +                    .display( 
-                        AdvancementFrame.TASK, // Options: TASK, CHALLENGE, GOAL +                            Items.DIRT, // The display icon 
-                        true, // Show toast top right +                            Text.literal("Your First Dirt Block"), // The title 
-                        true, // Announce to chat +                            Text.literal("Now make a three by three"), // The description 
-                        false // Hidden in the advancement tab +                            new Identifier("textures/gui/advancements/backgrounds/adventure.png"), // Background image used 
-                ) +                            AdvancementFrame.TASK, // Options: TASK, CHALLENGE, GOAL 
-                // The first string used in criterion is the name referenced by other advancements when they want to have 'requirements' +                            true, // Show toast top right 
-                .criterion("got_dirt", InventoryChangedCriterion.Conditions.items(Items.DIRT)) +                            true, // Announce to chat 
-                .build(consumer, "your_mod_id_please_change_me" + "/root");+                            false // Hidden in the advancement tab 
 +                    ) 
 +                    // The first string used in criterion is the name referenced by other advancements when they want to have 'requirements' 
 +                    .criterion("got_dirt", InventoryChangedCriterion.Conditions.items(Items.DIRT)) 
 +                    .build(consumer, "your_mod_id_please_change_me" + "/root"); 
 +        }
     }     }
 } }
 </code> </code>
  
-  * Make sure you change the ''your_mod_id_please_change_me'' string to the name of your mod. (Also leave the "/root" part as is).+  * Make sure you change the ''**your_mod_id_please_change_me**'' string to the name of your mod. (Also leave the "/root" part as is).
  
-I'll explain in more detail what everything means, but if you compile your program now, and jump into a world in minecraft, you'll notice nothing happens. That's because we haven't generated the data. We haven't ran the ''runDatagenClient'' gradle task we created earlier and we need to do that every time we add, modify, or remove one of our custom made advancements, otherwise the change won't be reflected in the game.+I'll explain in more detail what everything means, but if you compile your program now, and jump into a world in minecraft, you'll notice nothing happens. That's because we haven't generated the data. We haven't ran the ''**runDatagen**'' gradle task we created earlier and we need to do that every time we add, modify, or remove one of our custom made advancements, otherwise the change won't be reflected in the game.
  
-So open up your projects root directory on the terminal and run:+If you have a configuration on ''**IntelliJ IDEA**'' that runs the gradle task you can use that, 
 +or you can open your projects root folder on the terminal and run: 
 + 
 +<code bash Windows> 
 +gradlew runDatagen 
 +</code>
  
-<code bash> +<code bash Linux> 
-./gradlew runDatagenClient+./gradlew runDatagen
 </code> </code>
  
-In the ''generated'' folder we talked about before, you should now see a file ''root.json'' which holds our advancements data. Something like this:+In the ''**src/main/generated/data/minecraft/advancements/yourmodid/**'' folder we talked about before, you should now see a file ''**root.json**'' which holds our advancements data. Something like this:
  
 <code javascript> <code javascript>
Line 162: Line 142:
 </code> </code>
      
-Go ahead and run the game now and see if the advancement works by collecting a dirt block. You should even be able to leave the world, come back, collect another dirt block and notice that there is no re-trigger. If you press ''Escape'' and open up the Advancements tab, you should see our advancement with it's title and description, on it's own tab, separate from the vanilla advancements.+Go ahead and run the game now and see if the advancement works by collecting a dirt block. You should even be able to leave the world, come back, collect another dirt block and notice that there is no re-trigger. If you press ''**Escape**'' and open up the Advancements tab, you should see our advancement with it's title and description, on it's own tab, separate from the vanilla advancements.
  
   * **NOTE:** You have to complete one advancement in the tab group to open it up, otherwise the tab wont show (just in case you were wondering were the vanilla advancements were).   * **NOTE:** You have to complete one advancement in the tab group to open it up, otherwise the tab wont show (just in case you were wondering were the vanilla advancements were).
Line 168: Line 148:
 ===== Advancements Explained ===== ===== Advancements Explained =====
  
-All advancements in minecraft look like that ''root.json'' file we generated. In fact, it is not at all required to write any code to make advancements, as long as your mods blocks, items, weapons, and so on are registered on its given registry ([[blocks#registering_your_block|how that's done for blocks for example]]), you could reference any custom items your mod adds, be it food, or whatever and make advancements with them like if they were vanilla using datapacks. We still recommend you follow this method instead as it's far more durable than writing out advancements by hand.+All advancements in minecraft look like that ''**root.json**'' file we generated. In fact, it is not at all required to write any code to make advancements, as long as your mods blocks, items, weapons, and so on are registered on its given registry ([[blocks#registering_your_block|how that's done for blocks for example]]), you could reference any custom items your mod adds, be it food, or whatever and make advancements with them like if they were vanilla using datapacks. We still recommend you follow this method instead as it's far more durable than writing out advancements by hand.
  
-Let's go through the advancement we created step by step and see the options we have. We start by calling the ''Advancement.Builder.create()'' and assigning it to the variable ''rootAdvancement''. (We'll be making use of this later).+Let's go through the advancement we created step by step and see the options we have. We start by calling the ''**Advancement.Builder.create()**'' and assigning it to the variable ''**rootAdvancement**''. (We'll be making use of this later).
  
 <code java> <code java>
-Advancement rootAdvancement = Advancement.Builder.create()+AdvancementEntry rootAdvancement = Advancement.Builder.create()
 </code> </code>
  
Line 204: Line 184:
 </code> </code>
  
-Then we tell Minecraft when this advancement should be triggered (like after eating an item, or in our case, after a block enters our inventory) calling the ''criterion'' function.+Then we tell Minecraft when this advancement should be triggered (like after eating an item, or in our case, after a block enters our inventory) calling the ''**criterion**'' function.
  
 <code java> <code java>
Line 210: Line 190:
 </code> </code>
  
-The first argument is a name of type ''String''.+The first argument is a name of type ''**String**''.
  
-  * This name is only ever used by ''requirements'' (another property we can add to advancements) which make it so that before an advancement activates, the ''requirements'' (other advancements) need to be fulfilled first. In other words, it mostly doesn't matter what name you give the criterion.+  * This name is only ever used by ''**requirements**'' (another property we can add to advancements) which make it so that before an advancement activates, the ''**requirements**'' (other advancements) need to be fulfilled first. In other words, it mostly doesn't matter what name you give the criterion.
  
-The second argument is the criterion. In our example we use the ''InventoryChangedCriterion'' and we pass it the item we want it to trigger for ''Items.DIRT''. But there are many criterions. The Minecraft Wiki has them listed as "[[https://minecraft.fandom.com/wiki/Advancement/JSON_format|List of triggers]]". But the better reference to use is the Minecraft source itself. (If you haven't generated the source yet, read [[tutorial:setup#generating_minecraft_sources|here]].) You can take a look at the ''net.minecraft.advancement.criterion'' folder where they are all located and see what's already available.+The second argument is the criterion. In our example we use the ''**InventoryChangedCriterion**'' and we pass it the item we want it to trigger for ''**Items.DIRT**''. But there are many criterions. The Minecraft Wiki has them listed as "[[https://minecraft.wiki/w/Advancement/JSON_format#List_of_triggers|List of triggers]]". But the better reference to use is the Minecraft source itself. (If you haven't generated the source yet, read [[tutorial:setup#generating_minecraft_sources|here]].) You can take a look at the ''**net.minecraft.advancement.criterion**'' folder where they are all located and see what's already available.
  
 | PlayerHurtEntityCriterion.class | ImpossibleCriterion.class | Criterion.class | AbstractCriterion.class | VillagerTradeCriterion.class | PlayerHurtEntityCriterion.class | ImpossibleCriterion.class | Criterion.class | AbstractCriterion.class | VillagerTradeCriterion.class
Line 234: Line 214:
 </code> </code>
  
-We pass it the ''consumer'', and set the id of the advancement. +We pass it the ''**consumer**'', and set the id of the advancement. 
  
-  * Make sure you change the ''your_mod_id_please_change_me'' string to the name of your mod. (Also leave the "/root" part as is).+  * Make sure you change the ''**your_mod_id_please_change_me**'' string to the name of your mod. (Also leave the "/root" part as is).
  
 ===== One More Example ===== ===== One More Example =====
Line 244: Line 224:
  
 <code java> <code java>
-import net.minecraft.advancement.Advancement; +package com.example; 
-import net.minecraft.advancement.AdvancementFrame;+ 
 +import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint; 
 +import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator; 
 +import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput; 
 +import net.fabricmc.fabric.api.datagen.v1.provider.FabricAdvancementProvider; 
 +import net.minecraft.advancement.*; 
 +import java.util.function.Consumer; 
 +import net.minecraft.advancement.criterion.ConsumeItemCriterion;
 import net.minecraft.advancement.criterion.InventoryChangedCriterion; import net.minecraft.advancement.criterion.InventoryChangedCriterion;
 import net.minecraft.item.Items; import net.minecraft.item.Items;
Line 251: Line 238:
 import net.minecraft.util.Identifier; import net.minecraft.util.Identifier;
  
-import java.util.function.Consumer;+public class ExampleModDataGenerator implements DataGeneratorEntrypoint {
  
-public class Advancements implements Consumer<Consumer<Advancement>> {+    // ... (Rest of the code)
  
-    @Override +    static class AdvancementsProvider extends FabricAdvancementProvider {
-    public void accept(Consumer<Advancement> consumer) { +
-        Advancement rootAdvancement = Advancement.Builder.create() +
-                .display( +
-                        Items.DIRT, // The display icon +
-                        Text.literal("Your First Dirt Block"), // The title +
-                        Text.literal("Now make a three by three"), // The description +
-                        new Identifier("textures/gui/advancements/backgrounds/adventure.png"), // Background image used +
-                        AdvancementFrame.TASK, // Options: TASK, CHALLENGE, GOAL +
-                        true, // Show toast top right +
-                        true, // Announce to chat +
-                        false // Hidden in the advancement tab +
-                ) +
-                // The first string used in criterion is the name referenced by other advancements when they want to have 'requirements' +
-                .criterion("got_dirt", InventoryChangedCriterion.Conditions.items(Items.DIRT)) +
-                .build(consumer, "your_mod_id_please_change_me" + "/root");+
  
-        Advancement gotOakAdvancement = Advancement.Builder.create().parent(rootAdvancement) +        // ... (Rest of the code)
-                .display( +
-                        Items.OAK_LOG, +
-                        Text.literal("Your First Oak Block"), +
-                        Text.literal("Bare fisted"), +
-                        null, // children to parent advancements don't need a background set +
-                        AdvancementFrame.TASK, +
-                        true, +
-                        true, +
-                        false +
-                ) +
-                .rewards(AdvancementRewards.Builder.experience(1000)) +
-                .criterion("got_wood", InventoryChangedCriterion.Conditions.items(Items.OAK_LOG)) +
-                .build(consumer, "your_mod_id_please_change_me" + "/got_wood");+
  
-        Advancement eatAppleAdvancement = Advancement.Builder.create().parent(rootAdvancement) +        @Override 
-                .display( +        public void generateAdvancement(Consumer<AdvancementEntry> consumer) { 
-                        Items.APPLE, +            AdvancementEntry rootAdvancement = Advancement.Builder.create() 
-                        Text.literal("Apple and Beef"), +                    .display( 
-                        Text.literal("Ate an apple and beef"), +                            Items.DIRT, // The display icon 
-                        null, // children to parent advancements don't need a background set +                            Text.literal("Your First Dirt Block"), // The title 
-                        AdvancementFrame.CHALLENGE, +                            Text.literal("Now make a three by three"), // The description 
-                        true, +                            new Identifier("textures/gui/advancements/backgrounds/adventure.png"), // Background image used 
-                        true, +                            AdvancementFrame.TASK, // Options: TASK, CHALLENGE, GOAL 
-                        false +                            true, // Show toast top right 
-                ) +                            true, // Announce to chat 
-                .criterion("ate_apple", ConsumeItemCriterion.Conditions.item(Items.APPLE)) +                            false // Hidden in the advancement tab 
-                .criterion("ate_cooked_beef", ConsumeItemCriterion.Conditions.item(Items.COOKED_BEEF)) +                    ) 
-                .build(consumer, "your_mod_id_please_change_me" + "/ate_apple_and_beef");+                    // The first string used in criterion is the name referenced by other advancements when they want to have 'requirements' 
 +                    .criterion("got_dirt", InventoryChangedCriterion.Conditions.items(Items.DIRT)) 
 +                    .build(consumer, "your_mod_id_please_change_me" + "/root"); 
 + 
 +            AdvancementEntry gotOakAdvancement = Advancement.Builder.create().parent(rootAdvancement) 
 +                    .display( 
 +                            Items.OAK_LOG, 
 +                            Text.literal("Your First Log"), 
 +                            Text.literal("Bare fisted"), 
 +                            null, // children to parent advancements don't need a background set 
 +                            AdvancementFrame.TASK, 
 +                            true, 
 +                            true, 
 +                            false 
 +                    ) 
 +                    .rewards(AdvancementRewards.Builder.experience(1000)) 
 +                    .criterion("got_wood", InventoryChangedCriterion.Conditions.items(Items.OAK_LOG)) 
 +                    .build(consumer, "your_mod_id_please_change_me" + "/got_wood"); 
 + 
 +            AdvancementEntry eatAppleAdvancement = Advancement.Builder.create().parent(rootAdvancement) 
 +                    .display( 
 +                            Items.APPLE, 
 +                            Text.literal("Apple and Beef"), 
 +                            Text.literal("Ate an apple and beef"), 
 +                            null, // children to parent advancements don't need a background set 
 +                            AdvancementFrame.CHALLENGE, 
 +                            true, 
 +                            true, 
 +                            false 
 +                    ) 
 +                    .criterion("ate_apple", ConsumeItemCriterion.Conditions.item(Items.APPLE)) 
 +                    .criterion("ate_cooked_beef", ConsumeItemCriterion.Conditions.item(Items.COOKED_BEEF)) 
 +                    .build(consumer, "your_mod_id_please_change_me" + "/ate_apple_and_beef"); 
 +        }
     }     }
 } }
 </code> </code>
  
-Don't forget to generate the data.+Don't forget to generate the data (Run the gradle task). 
 + 
 +<code bash Windows> 
 +gradlew runDatagen 
 +</code>
  
-<code bash> +<code bash Linux> 
-./gradlew runDatagenClient+./gradlew runDatagen
 </code> </code>
  
-We added another advancement that activates when you get an oak log this time, and which awards one-thousand experience when completed. And another advancements which the player must actually complete two criterions for, before being awarded the advancement. One criterion to eat an apple, and one criterion to eat cooked beef. This was done by just chain linking some method calls. We've also, importantly, put reasonable values for the fields, like calling the criterion that triggers when an apple is eaten 'ate_apple'. Also notice that we kept the "your_mod_id_please_change_me" part the same but changed the second part with the dash:+We added an advancement that activates when you get an oak log, and which awards one-thousand experience when completed. And we added another advancement which the player must actually complete two criterions for, before being awarded the advancement. One criterion to eat an apple, and one criterion to eat cooked beef. This was done by just chain linking some method calls. We've also, importantly, put reasonable values for the fields, like calling the criterion that triggers when an apple is eaten 'ate_apple'. Also notice that we kept the "your_mod_id_please_change_me" part the same but changed the second part with the dash:
  
 <code java> <code java>
Line 324: Line 320:
  
 <code java> <code java>
-Advancement gotOakAdvancement = Advancement.Builder.create().parent(rootAdvancement)+AdvancementEntry gotOakAdvancement = Advancement.Builder.create().parent(rootAdvancement)
  
 // .... // ....
  
-Advancement eatAppleAdvancement = Advancement.Builder.create().parent(rootAdvancement)+AdvancementEntry eatAppleAdvancement = Advancement.Builder.create().parent(rootAdvancement)
 </code> </code>
  
   * If an advancement doesn't have a parent, it creates a new page, and becomes its root.   * If an advancement doesn't have a parent, it creates a new page, and becomes its root.
  
-We also, of course, changed the titles and descriptions, and even the frame for the ''ate_apple_and_beef'' advancement into a challenge type. (Those advancements which print out in purple and make crazy sound effects). One thing to keep in mind is the current root advancement for our mod is not very good. You want it to be something that is almost guaranteed to happen in your mod. For instance some mods make the root advancement triggered by detecting a custom book in the players inventory (a tutorial book basically), and then put the book in the players inventory when they spawn. The root advancement should be basically free, the children should be challenges.+We also, of course, changed the titles and descriptions, and even the frame for the ''**ate_apple_and_beef**'' advancement into a challenge type. (Those advancements which print out in purple and make crazy sound effects). One thing to keep in mind is the current root advancement for our mod is not very good. You want it to be something that is almost guaranteed to happen in your mod. For instance some mods make the root advancement triggered by detecting a custom book in the players inventory (a tutorial book basically), and then put the book in the players inventory when they spawn. The root advancement should be basically free, the children should be challenges.
  
 ===== When To Make a Custom Criterion? ===== ===== When To Make a Custom Criterion? =====
Line 343: Line 339:
 ===== How To Make a Custom Criterion? ===== ===== How To Make a Custom Criterion? =====
  
-Our mod is keeping track of how many jumping jacks a player has done, and we want to make an advancement when they complete one hundred. First thing we got to do is make the ''JumpingJacks'' class which will extend the ''AbstractCriterion<JumpingJacks.Condition>'' class like so:+To start, let's create a new minecraft mechanic. 
 + 
 +In your ''**.java**'' class which ''**implements ModInitializer**'', write the following: 
 + 
 +<code java> 
 +import net.fabricmc.api.ModInitializer; 
 +import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents; 
 +import net.minecraft.item.Item; 
 +import net.minecraft.server.network.ServerPlayerEntity; 
 +import net.minecraft.text.Text; 
 + 
 +import java.util.HashMap; 
 + 
 +public class ExampleMod implements ModInitializer { 
 + 
 +    public static final String MOD_ID = "your_unique_mod_id_change_me_please"; 
 + 
 +    @Override 
 +    public void onInitialize() { 
 +        HashMap<Item, Integer> tools = new HashMap<>(); 
 + 
 +        PlayerBlockBreakEvents.AFTER.register((world, player, pos, state, entity) -> { 
 +            if (player instanceof ServerPlayerEntity) { 
 +                Item item = player.getMainHandStack().getItem(); 
 + 
 +                Integer wrongToolUsedCount = tools.getOrDefault(item, 0); 
 +                wrongToolUsedCount++; 
 +                tools.put(item, wrongToolUsedCount); 
 + 
 +                player.sendMessage(Text.literal("You've used '" + item + "' as a wrong tool: " + wrongToolUsedCount + " times.")); 
 +            } 
 +        }); 
 +    } 
 +} 
 +</code> 
 + 
 +In the code, when we detect the player has broken a block, we pull out the ''**Integer**'' out of the hashmap using the active ''**Item**'' in the players hand and increase the ''**Integer**'' by one. We then store that ''**Integer**'' back in the ''**HashMap**''. 
 + 
 +  * Note: the ''**HashMap**'' isn't being saved using [[persistent_states|Persistent Storage]] so when the world closes, whatever ''**Integer**'''s were being stored, are lost. The mechanic is also //not// keeping track of each player individually. In other words: This code is really bad, and written solely to show off custom criterions. 
 + 
 +If you launch the game now, you should see a message pop up everytime you break a block telling you how many times that ''**Item**'' has been used as a 'wrong' tool. Understand what is happening thoroughly before continuing. 
 + 
 +Next, let's create a custom criterion ''**WrongToolCriterion**'' which will be triggered and granted when we detect our custom game mechanic. In the same folder as your ''**.java**'' class which ''**implements ModInitializer**'' create a new file ''**WrongToolCriterion.java**'' and fill it as follows:
  
 <code java> <code java>
Line 350: Line 388:
 import net.minecraft.advancement.criterion.AbstractCriterionConditions; import net.minecraft.advancement.criterion.AbstractCriterionConditions;
 import net.minecraft.predicate.entity.AdvancementEntityPredicateDeserializer; import net.minecraft.predicate.entity.AdvancementEntityPredicateDeserializer;
-import net.minecraft.predicate.entity.EntityPredicate;+import net.minecraft.predicate.entity.LootContextPredicate;
 import net.minecraft.server.network.ServerPlayerEntity; import net.minecraft.server.network.ServerPlayerEntity;
-import net.minecraft.util.Identifier; 
  
-public class JumpingJacks extends AbstractCriterion<JumpingJacks.Condition> {+import java.util.Optional; 
 +import java.util.function.Predicate;
  
-    /** +public class WrongToolCriterion { 
-    /* Don't forget to change: "your_mod_id_please_change_me" +    // 
-     **/ +    // Nothing yet 
-    public static final Identifier ID = new Identifier("your_mod_id_please_change_me", "jumping_jacks");+    // 
 +} 
 +</code>
  
-    @Override +Now, write a class inside our ''**WrongToolCriterion**'' class which ''**extends AbstractCriterionConditions**''. We will call it ''**Conditions**''. It will force you to implement the constructor. 
-    protected Condition conditionsFromJson(JsonObject obj, EntityPredicate.Extended playerPredicate, AdvancementEntityPredicateDeserializer predicateDeserializer) { + 
-        return new Condition();+<code java> 
 +public class WrongToolCriterion { 
 + 
 +    public static class Conditions extends AbstractCriterionConditions { 
 +        public Conditions() { 
 +            // The base class Constructor wants an 'Optional<LootContextPredicate> playerPredicate'. 
 +            // Since it's optional, we give them nothing. 
 +            super(Optional.empty()); 
 +        } 
 + 
 +        boolean requirementsMet() { 
 +            return true; 
 +        }
     }     }
 +}
 +</code>
 +
 +  * Note: At the moment, our ''**WrongToolCriterion**'' has no requirements, so we just return true always from the function ''**requirementsMet**''.
 +
 +Make our class ''**WrongToolCriterion**'' extend ''**AbstractCriterion**'' which will take a type. In fact, it's going to take a ''**class**'' of type ''**AbstractCriterionConditions**'' (the class we just wrote). Should look like:
 +
 +<code java [highlight_lines_extra="1"]>
 +public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> {
 +
 +    public static class Conditions extends AbstractCriterionConditions {
 +        public Conditions() {
 +            super(Optional.empty());
 +        }
 +
 +        boolean requirementsMet() {
 +            return true;
 +        }
 +    }
 +}
 +</code>
 +
 +The code will now be complaining that you need to implement the ''**conditionsFromJson**'' function. So do so:
 +
 +<code java [highlight_lines_extra="3,4,5,6,7,8,9"]>
 +public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> {
  
     @Override     @Override
-    public Identifier getId() { +    protected Conditions conditionsFromJson(JsonObject json, 
-        return ID;+                                            Optional<LootContextPredicate> playerPredicate, 
 +                                            AdvancementEntityPredicateDeserializer predicateDeserializer) { 
 +        Conditions conditions = new Conditions(); 
 +        return conditions;
     }     }
  
-    public void trigger(ServerPlayerEntity player) { +    public static class Conditions extends AbstractCriterionConditions { 
-        trigger(player, condition -> {+        public Conditions() { 
 +            super(Optional.empty()); 
 +        } 
 + 
 +        boolean requirementsMet() {
             return true;             return true;
 +        }
 +    }
 +}
 +</code>
 +
 +You may be asking yourself, what exactly is this ''**conditionsFromJson**'' function? When does it get called? Who calls it? What data does it get passed in? And what is it supposed to return? All very good questions. As has been mentioned before, advancements are simply ''**.json**'' files. This function ''**conditionsFromJson**'' gets passed in the ''**conditions**'' section from our advancements' ''**.json**'' files. In fact, the example advancements we wrote earlier in the article (''**root.json**'') had a conditions section.
 +
 +<code javascript [highlight_lines_extra="4,5,6,7,8,9,10,11,12"]>
 +{
 +  "criteria": {
 +    "got_dirt": {
 +      "conditions": {
 +        "items": [
 +          {
 +            "items": [
 +              "minecraft:dirt"
 +            ]
 +          }
 +        ]
 +      },
 +      "trigger": "minecraft:inventory_changed"
 +    }
 +  },
 +
 +  // ... (Rest of json)
 +}
 +</code>
 +
 +The ''**JsonObject**'' which you receive in the function is simply the above highlighted json. You are meant to pull out any data you need from it and pass it to the constructor of the ''**Conditions**'' object, and save it as fields. We then return that ''**new Conditions**'' object. Since our custom criterion is not going to have any 'requirements' we won't need to worry about loading and saving from json, yet.
 +
 +The final modification we need to complete our ''**WrongToolCriterion**'' is to write a trigger function. This is the function we are going to call when we detect our new game mechanic activating.
 +
 +<code java>
 +public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> {
 +
 +    // ... (Rest of the code)
 +
 +    protected void trigger(ServerPlayerEntity player) {
 +        trigger(player, conditions -> {
 +            return conditions.requirementsMet();
         });         });
     }     }
 +}
 +</code>
  
-    public static class Condition extends AbstractCriterionConditions {+Inside our trigger function, we call another trigger function (the one in the base class ''**AbstractCriterion**''). The function which we are calling takes in a ''**ServerPlayerEntity**'' and a ''**Predicate<Conditions>**''.
  
-        public Condition() { +==== What's a predicate? ==== 
-            super(ID, EntityPredicate.Extended.EMPTY); + 
-        }+In simple terms, the ''**Predicate**'' is going to hand you a variable of the type which is inside its ''<...>'' (in our case we get handed a variable of the type: ''**Conditions**'' (the class we wrote)) and it wants us to return true or false based on whatever criteria we want. 
 + 
 +What //we// do is call the function ''**requirementsMet**'' (which returns a boolean) on the conditions variable, and return that. (We could've just ''**return true**'' instead of ''**return conditions.requirementsMet()**'' as well.) It will become clear how you can use this to have requirements on your criterions soon, but for now, any time our ''**trigger**'' function gets called, it grants the advacement. 
 + 
 +The next step is to add our ''**WrongToolCriterion**'' to the ''**Criteria**'' register.  
 + 
 +In your class which ''**implements ModInitializer**'' add the following: 
 + 
 +<code java [highlight_lines_extra="13,27"]> 
 +import net.fabricmc.api.ModInitializer; 
 +import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents; 
 +import net.minecraft.advancement.criterion.Criteria; 
 +import net.minecraft.item.Item; 
 +import net.minecraft.server.network.ServerPlayerEntity; 
 +import net.minecraft.text.Text; 
 +import java.util.HashMap; 
 + 
 +public class ExampleMod implements ModInitializer { 
 + 
 +    public static final String MOD_ID = "your_unique_mod_id_change_me_please"; 
 + 
 +    public static WrongToolCriterion WRONG_TOOl = Criteria.register(MOD_ID + "/wrong_tool", new WrongToolCriterion()); 
 + 
 +    @Override 
 +    public void onInitialize() { 
 +        HashMap<Item, Integer> tools = new HashMap<>(); 
 + 
 +        PlayerBlockBreakEvents.AFTER.register((world, player, pos, state, entity) -> { 
 +            if (player instanceof ServerPlayerEntity) { 
 +                Item item = player.getMainHandStack().getItem(); 
 + 
 +                Integer wrongToolUsedCount = tools.getOrDefault(item, 0); 
 +                wrongToolUsedCount++; 
 +                tools.put(item, wrongToolUsedCount); 
 + 
 +                WRONG_TOOl.trigger((ServerPlayerEntity) player); 
 + 
 +                player.sendMessage(Text.literal("You've used '" + item + "' as a wrong tool: " + wrongToolUsedCount + " times.")); 
 +            } 
 +        });
     }     }
 } }
 </code> </code>
  
-You'll notice inside the class, there is another class called ''Condition'' which implements ''AbstractCriterionConditions''. It just calls the super function for now and nothing else. In fact this whole class is basically doing nothing, (other than making an ID). The only function that does anything is the ''trigger'' function which calls the ''trigger'' function which exists in the ''AbstractCriterion'' class we extended, and which we, with no checking against any data, return true always. That means that **any** time this JumpingJacks criterion is triggered, it'll award the player the advancement.+  * Note: the first parameter (a string) can be anything. We prepend it with the ''**MOD_ID**'' so that our name doesn't clash with any of the default minecraft ''**Criterion**'''s or other mods.
  
-Let's create an advancement with it now.+Now, when we detect our custom game mechanic being activated we call the trigger function of the criterion, and if there are any advancements who use that criteria, they should be satisfied and grant you the advancement. 
 + 
 +In our ''**FabricAdvancementProvider**'' class which we wrote earlier write the following advancement using our custom criteria:
  
 <code java> <code java>
-import net.minecraft.advancement.Advancement; +import net.fabricmc.fabric.api.datagen.v1.DataGeneratorEntrypoint; 
-import net.minecraft.advancement.AdvancementFrame;+import net.fabricmc.fabric.api.datagen.v1.FabricDataGenerator; 
 +import net.fabricmc.fabric.api.datagen.v1.FabricDataOutput; 
 +import net.fabricmc.fabric.api.datagen.v1.provider.FabricAdvancementProvider; 
 +import net.minecraft.advancement.*; 
 +import java.util.function.Consumer;
 import net.minecraft.item.Items; import net.minecraft.item.Items;
 import net.minecraft.text.Text; import net.minecraft.text.Text;
 import net.minecraft.util.Identifier; import net.minecraft.util.Identifier;
  
-import java.util.function.Consumer; +public class ExampleModDataGenerator implements DataGeneratorEntrypoint {
- +
-public class Advancements implements Consumer<Consumer<Advancement>> {+
  
     @Override     @Override
-    public void accept(Consumer<Advancement> consumer) { +    public void onInitializeDataGenerator(FabricDataGenerator generator) { 
-        Advancement rootAdvancement = Advancement.Builder.create() +        FabricDataGenerator.Pack pack = generator.createPack(); 
-                .display( + 
-                        Items.BLUE_BED, +        pack.addProvider(AdvancementsProvider::new); 
-                        Text.literal("Jumping Jacks"), +    } 
-                        Text.literal("You jumped Jack 100 times"), + 
-                        new Identifier("textures/gui/advancements/backgrounds/adventure.png"), +    static class AdvancementsProvider extends FabricAdvancementProvider { 
-                        AdvancementFrame.TASK, +        protected AdvancementsProvider(FabricDataOutput dataGenerator) { 
-                        true, +            super(dataGenerator); 
-                        true, +        } 
-                        false + 
-                ) +        @Override 
-                .criterion("jumping_jacks", new JumpingJacks.Condition()) +        public void generateAdvancement(Consumer<AdvancementEntry> consumer) { 
-                .build(consumer, "your_mod_id_please_change_me" + "/root");+            AdvancementEntry rootAdvancement = Advancement.Builder.createUntelemetered() 
 +                    .display( 
 +                            Items.BELL, 
 +                            Text.literal("Wrong Tool Buddy"), 
 +                            Text.literal("That's not the right tool"), 
 +                            new Identifier("textures/gui/advancements/backgrounds/adventure.png"), 
 +                            AdvancementFrame.TASK, 
 +                            true, 
 +                            true, 
 +                            false 
 +                    ) 
 +                    .criterion("wrong_tool", ExampleMod.WRONG_TOOl.create(new WrongToolCriterion.Conditions())) 
 +                    .build(consumer, "your_mod_id_please_change_me" + "/root"); 
 +        }
     }     }
 } }
 </code> </code>
  
-Because we've changed the advancement generator code, don't forget to generate the data again. 
  
-<code bash> +Remember that after any modification we make to our ''**DataGeneratorEntrypoint**'' we need to run the gradle task ''**runDatagen**''. 
-./gradlew runDatagenClient+ 
 +<code bash Windows> 
 +gradlew runDatagen
 </code> </code>
  
-Before, with the vanilla provided criterions, we would've been done at this stage, but because we created the criterion, we need to actually call the trigger function ourselves, and register it. Behind the scenes, for the consume item criterion for instance, minecraft is doing this kind of trigger. You can see in the eat function that every time the player eats, it sends the item that was ate to the consume item criterion to check if an advancement should be awarded. We have to do the same for our mod. We are responsible for calling the trigger function. Here's an example:+<code bash Linux> 
 +./gradlew runDatagen 
 +</code>
  
-<code java>+Or if you have the configuration in your IDE, run that. 
 + 
 +If you launch the game now, when you break a block, you should be granted our custom advacement satisfied from our custom game mechanic, using our custom criterion. 
 + 
 +===== Conditions with State ===== 
 + 
 +With just what we have, we can already manually have any custom requirements for our advancements, that is, maybe we'd like are advancement to only be granted if the player has used the wrong tool atleast five times, or they had to be jumping while doing it, or any other things we might want to be true. And then, only when all the things we want to be true, are true, do we call the trigger function. 
 + 
 +Look at the following: 
 + 
 +<code java [highlight_lines_extra="27,28,29"]>
 import net.fabricmc.api.ModInitializer; import net.fabricmc.api.ModInitializer;
-import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;+import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents;
 import net.minecraft.advancement.criterion.Criteria; import net.minecraft.advancement.criterion.Criteria;
 +import net.minecraft.item.Item;
 +import net.minecraft.server.network.ServerPlayerEntity;
 +import net.minecraft.text.Text;
 +import java.util.HashMap;
 +
 +public class ExampleMod implements ModInitializer {
  
-public class AdvancementTutorial implements ModInitializer {+    public static final String MOD_ID = "your_unique_mod_id_change_me_please";
  
-    /** +    public static WrongToolCriterion WRONG_TOOl = Criteria.register(MOD_ID + "/wrong_tool", new WrongToolCriterion());
-    /* You ABSOLUTELY must register your custom +
-    /* criterion as done below for each one you create: +
-     */ +
-    public static JumpingJacks JUMPING_JACKS = Criteria.register(new JumpingJacks());+
  
     @Override     @Override
     public void onInitialize() {     public void onInitialize() {
-        ServerPlayConnectionEvents.JOIN.register((handler, origin, destination) -> { +        HashMap<Item, Integer> tools = new HashMap<>(); 
-            if (checkedPlayerStateAndHesJumpedOneHundredTimes(handler.player)) { + 
-                // +        PlayerBlockBreakEvents.AFTER.register((world, player, pos, state, entity) -> { 
-                // Because of the way we wrote our JumpingJacks class,  +            if (player instanceof ServerPlayerEntity) { 
-                // calling the trigger function will ALWAYS grant us the advancement. +                Item item = player.getMainHandStack().getItem(); 
-                // + 
-                JUMPING_JACKS.trigger(handler.player);+                Integer wrongToolUsedCount = tools.getOrDefault(item, 0); 
 +                wrongToolUsedCount++; 
 +                tools.put(item, wrongToolUsedCount); 
 + 
 +                if (wrongToolUsedCount > 5) { 
 +                    WRONG_TOOl.trigger((ServerPlayerEntity) player); 
 +                } 
 + 
 +                player.sendMessage(Text.literal("You've used '" + item + "' as a wrong tool: " + wrongToolUsedCount + " times."));
             }             }
         });         });
Line 456: Line 662:
 </code> </code>
  
-  * Because we aren't implementing a full blown mod we pretend a function ''checkedPlayerStateAndHesJumpedOneHundredTimes'' exists and returns true when the player has done more than one-hundred jumping jacks.+If you run the game now, and break some blocks, you'll notice the advancement will only be granted when you've used the wrong tool to break some block atleast five times. 
  
-  * **NOTE:** You must call ''Criteria.register'' with your custom made criterion, or your game won't award the advancements. (And it MUST be done server side, which is why we do this in the ''ModInitializer'' class).+This is really all most modders need.
  
-If you run your game now (changing that fake function to a simple ''true'' so it compiles), when you log into a world, you should be granted the jumping jack advancement, but because we are using the server join event here to do this, it gives it to you before you load in, which is why you don't get a toast message. If you open up the advancements page in the escape menu, you'll see it was in fact granted.+So when do you need criterion's that hold state?
  
-The last thing to do is to make a criterion that takes in some data when created and uses it during when the trigger function is called. (Like how the consume item criterion takes an ''Item'', and then only triggers when that specific ''Item'' is consumed).+You should use them when you have some advancements which are very similar in function but slightly different. Like if we wanted an advancement when the player has used the wrong tool 1 time, and also 5 times, and also 10 times, then what we would do without criterions with state is have to copy and paste our criterion three times blowing up the size of the code, registering all three, and calling them seperately. This is a perfect example of where if the ''**Conditions**'' simply took an ''**Integer**'' specifying how many times an item had to be used as a wrong tool before activating, it would greately improve our code.
  
-===== Criterion with State =====+To do so, first, in our ''**Conditions**'' class, add a parameter to the constructor, an ''**Integer**'', and assign it to a field, that way the ''**Conditions**'' has a copy of the number for later use.
  
-We can imagine a mod that has different elemental wands you could use, like fire, water, ice and so on, and that each of these categories has multiple varieties (2 fire wands, 4 water wands, 3 ice wands). Let's say we want to make an advancement every time the player has used every wand in a specific category (all the ice wands, or all the fire wands). We //could// use what we know so far to accomplish this. We would simply make three criterions, fire, water, and ice, that we trigger when we've detected the user has used all the wands in that category. But we could save ourselves a lot of copy pasting by passing in a little bit of state when the criterion is made.+<code java [highlight_lines_extra="6,11"]> 
 +public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> { 
 +    // ... (Rest of the code) 
 + 
 +    public static class Conditions extends AbstractCriterionConditions { 
 + 
 +        Integer minimumAmount; 
 + 
 +        public Conditions(Integer minimumAmount) { 
 +            super(Optional.empty()); 
 + 
 +            this.minimumAmount = minimumAmount; 
 +        } 
 + 
 +        boolean requirementsMet() { 
 +            return true; 
 +        } 
 +    } 
 + 
 +    // ... (Rest of the code) 
 +} 
 + 
 +</code> 
 + 
 +  * Note: anywhere in the code where ''**new WrongToolCriterion.Conditions()**'' was called should be complaining but lets ignore it for now. 
 + 
 +@Override the ''**toJson**'' function inside ''**Conditions**'' and write the following: 
 + 
 +<code java [highlight_lines_extra="7,8,9,10,11,12"]> 
 +public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> { 
 +    // ... (Rest of the code) 
 + 
 +    public static class Conditions extends AbstractCriterionConditions { 
 +        // ... (Rest of the code) 
 + 
 +        @Override 
 +        public JsonObject toJson() { 
 +            JsonObject json = super.toJson(); 
 +            json.addProperty("amount", minimumAmount); 
 +            return json; 
 +        } 
 +    } 
 + 
 +    // ... (Rest of the code) 
 +} 
 + 
 +</code> 
 + 
 +When our gradle task ''**runDatagen**'' is ran, it calls //this// ''**toJson**'' function when it's writing the conditions portion of our custom advacements. That's why we make sure to add to the ''**JsonObject**'' our ''**Conditions**'''s private data: the field ''**minimumAmount**''. That way when the game is ran, and it reads the advacement off the disk (in ''**conditionsFromJson**''), it can read off the ''**Integer**'' we saved here. 
 + 
 +Rewrite the ''**conditionsFromJson**'' as follows:
  
 <code java> <code java>
-import com.google.gson.JsonElement;+public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> { 
 + 
 +    @Override 
 +    protected Conditions conditionsFromJson(JsonObject json, 
 +                                            Optional<LootContextPredicate> playerPredicate, 
 +                                            AdvancementEntityPredicateDeserializer predicateDeserializer) { 
 +        Integer minimiumAmount = json.get("amount").getAsInt(); 
 +        Conditions conditions = new Conditions(minimiumAmount); 
 +        return conditions; 
 +    } 
 + 
 +    // ... (Rest of the code) 
 +} 
 +</code> 
 + 
 +As we spoke about before, this funciton is called when the game client is ran and it passes us the ''**JsonObject**'' we wrote in ''**toJson**'', therefore we read out the ''**amount**'' and cast it to an ''**Integer**'' which we know it is. We then pass that to the ''**Conditions**'' constructor so it can store it as a field. 
 + 
 +Let's use that field now. Add a new parameter to our ''**requirementsMet**'' function, an ''**Integer**'', which is supposed to be the amount that a particular item has used the wrong tool. In the function we will return true if that item has used more than the minimium the criteria requires. The final ''**WrongToolCriterion**'' should be as follows: 
 + 
 +<code java [highlight_lines_extra="30,31,32,42,43,44,45"]>
 import com.google.gson.JsonObject; import com.google.gson.JsonObject;
-import com.google.gson.JsonPrimitive; 
 import net.minecraft.advancement.criterion.AbstractCriterion; import net.minecraft.advancement.criterion.AbstractCriterion;
 import net.minecraft.advancement.criterion.AbstractCriterionConditions; import net.minecraft.advancement.criterion.AbstractCriterionConditions;
 import net.minecraft.predicate.entity.AdvancementEntityPredicateDeserializer; import net.minecraft.predicate.entity.AdvancementEntityPredicateDeserializer;
-import net.minecraft.predicate.entity.AdvancementEntityPredicateSerializer; +import net.minecraft.predicate.entity.LootContextPredicate;
-import net.minecraft.predicate.entity.EntityPredicate;+
 import net.minecraft.server.network.ServerPlayerEntity; import net.minecraft.server.network.ServerPlayerEntity;
-import net.minecraft.util.Identifier;+import java.util.Optional;
  
-public class WandCategoryUsed extends AbstractCriterion<WandCategoryUsed.Condition> { +public class WrongToolCriterion extends AbstractCriterion<WrongToolCriterion.Conditions> {
- +
-    public static final Identifier ID = new Identifier("your_modid_here_please_change_me", "finished_wand_category");+
  
     @Override     @Override
-    protected Condition conditionsFromJson(JsonObject obj, EntityPredicate.Extended playerPredicate, AdvancementEntityPredicateDeserializer predicateDeserializer) { +    protected Conditions conditionsFromJson(JsonObject json, 
-        JsonElement cravingTarget = obj.get("wandElement"); +                                            Optional<LootContextPredicate> playerPredicate, 
-        return new Condition(cravingTarget.getAsString());+                                            AdvancementEntityPredicateDeserializer predicateDeserializer) { 
 +        Integer minimiumAmount = json.get("amount").getAsInt(); 
 +        Conditions conditions = new Conditions(minimiumAmount); 
 +        return conditions;
     }     }
  
-    @Override +    public static class Conditions extends AbstractCriterionConditions {
-    public Identifier getId() { +
-        return ID; +
-    }+
  
-    public void trigger(ServerPlayerEntity player, String wandElement) { +        Integer minimumAmount;
-        trigger(player, condition -> condition.test(wandElement)); +
-    }+
  
-    public static class Condition extends AbstractCriterionConditions { +        public Conditions(Integer minimumAmount) { 
-        String wandElement;+            super(Optional.empty());
  
-        public Condition(String wandElement) { +            this.minimumAmount = minimumAmount;
-            super(ID, EntityPredicate.Extended.EMPTY); +
-            this.wandElement = wandElement;+
         }         }
  
-        public boolean test(String wandElement) { +        boolean requirementsMet(Integer amount) { 
-            return this.wandElement.equals(wandElement);+            return amount > minimumAmount;
         }         }
  
         @Override         @Override
-        public JsonObject toJson(AdvancementEntityPredicateSerializer predicateSerializer) { +        public JsonObject toJson() { 
-            JsonObject jsonObject = super.toJson(predicateSerializer); +            JsonObject json = super.toJson(); 
-            jsonObject.add("wandElement", new JsonPrimitive(wandElement)); +            json.addProperty("amount", minimumAmount); 
-            return jsonObject;+            return json;
         }         }
 +    }
 +
 +    protected void trigger(ServerPlayerEntity player, Integer amount) {
 +        trigger(player, conditions -> {
 +            return conditions.requirementsMet(amount);
 +        });
     }     }
 } }
 </code> </code>
  
-Our ''Condition'' class now takes in a string in it's constructor and saves it for later use. The ''Condition'' class also has a new function ''test'' which takes in a string and returns true if it equals it's own ''wandElment'' string. In the ''toJson'' function we convert the ''wandElement'' to json so it can be saved to disk.+In our class which ''**implements ModInitializer**'' re-write our trigger function:
  
-You'll also notice that the ''trigger'' function doesn't just return true now, it actually uses the new ''test'' function in the ''Condition'' class to see if the passed in data matches. And in the ''conditionsFromJson'' we convert the saved out ''wandElement'' json back to string.+<code java [highlight_lines_extra="19"]> 
 +public class ExampleMod implements ModInitializer {
  
-Now we could write our advancement like so:+    public static final String MOD_ID = "your_unique_mod_id_change_me_please";
  
-<code java> +    public static WrongToolCriterion WRONG_TOOl = Criteria.register(MOD_ID + "/wrong_tool", new WrongToolCriterion());
-Advancement.Builder.create() +
-        .display(Items.FIRE_WAND_1, Text.literal("Used all water wands"), +
-                Text.literal("Used all water wands"), +
-                null, +
-                AdvancementFrame.TASK, +
-                true, +
-                true, +
-                false +
-        ) +
-        .parent(parentAdvancement) +
-        .criterion("used_all_fire_wands", new WandCategoryUsed.Condition("fire")) +
-        .build(consumer, "your_mod_id_please_change_me" + "/used_all_fire_wands");+
  
-Advancement.Builder.create() +    @Override 
-        .display(Items.ICE_WAND_1, Text.literal("Used all ice wands"), +    public void onInitialize() { 
-                Text.literal("Used all ice wands"), +        HashMap<Item, Integer> tools = new HashMap<>(); 
-                null,+ 
 +        PlayerBlockBreakEvents.AFTER.register((world, player, pos, state, entity) -> { 
 +            if (player instanceof ServerPlayerEntity) { 
 +                Item item = player.getMainHandStack().getItem(); 
 + 
 +                Integer wrongToolUsedCount = tools.getOrDefault(item, 0); 
 +                wrongToolUsedCount++; 
 +                tools.put(item, wrongToolUsedCount); 
 + 
 +                WRONG_TOOl.trigger((ServerPlayerEntity) player, wrongToolUsedCount); 
 + 
 +                player.sendMessage(Text.literal("You've used '" + item + "' as a wrong tool: " + wrongToolUsedCount + " times.")); 
 +            } 
 +        }); 
 +    } 
 +} 
 +</code> 
 + 
 +And finally, pass 3 to the custom advancement and create a second one as well. (Dont forget to re-run the gradle task ''**runDatagen**'') 
 + 
 +<code java [highlight_lines_extra="12,26"]> 
 +AdvancementEntry rootAdvancement = Advancement.Builder.createUntelemetered() 
 +        .display( 
 +                Items.BELL, 
 +                Text.literal("Wrong Tool Buddy"), 
 +                Text.literal("That's not the right tool"), 
 +                new Identifier("textures/gui/advancements/backgrounds/adventure.png"),
                 AdvancementFrame.TASK,                 AdvancementFrame.TASK,
                 true,                 true,
Line 550: Line 838:
                 false                 false
         )         )
-        .parent(parentAdvancement) +        .criterion("wrong_tool", ExampleMod.WRONG_TOOl.create(new WrongToolCriterion.Conditions(3))) 
-        .criterion("used_all_ice_wands", new WandCategoryUsed.Condition("ice")) +        .build(consumer, "your_mod_id_please_change_me" + "/root");
-        .build(consumer, "your_mod_id_please_change_me" + "/used_all_ice_wands");+
  
-Advancement.Builder.create() +AdvancementEntry second = Advancement.Builder.createUntelemetered().parent(rootAdvancement) 
-        .display(Items.WATER_WAND_1, Text.literal("Used all water wands"), +        .display( 
-                Text.literal("Used all water wands"), +                Items.QUARTZ, 
-                null,+                Text.literal("You did hear me didn't you?"), 
 +                Text.literal("That's not the right tool"), 
 +                new Identifier("textures/gui/advancements/backgrounds/adventure.png"),
                 AdvancementFrame.TASK,                 AdvancementFrame.TASK,
                 true,                 true,
Line 563: Line 852:
                 false                 false
         )         )
-        .parent(parentAdvancement) +        .criterion("wrong_tool", ExampleMod.WRONG_TOOl.create(new WrongToolCriterion.Conditions(5))) 
-        .criterion("used_all_water_wands", new WandCategoryUsed.Condition("water")) +        .build(consumer, "your_mod_id_please_change_me" + "/root");
-        .build(consumer, "your_mod_id_please_change_me" + "/used_all_water_wands");+
 </code> </code>
  
-Then we'd make sure to register the criterion (logical server side).+If you run the game now (don't forget to re-run the gradle task ''**runDatagen**''), you should see that the advancements are granted when their conditions are met '3' and '5' respectively (actually '4' and '6' because we didn't use '>=').
  
-<code java> +You can also see the conditions section of the ''**root.json**'' file has the variable we wrote ''**amount**'':
-public static WandCategoryUsed WAND_USED = Criteria.register(new WandCategoryUsed()); +
-</code>+
  
-And whenever we detected the player having used all the wands for a particular category, we could trigger the advancement like this: +<code javascript> 
- +{ 
-<code java> +  "criteria": { 
-if (playerUsedAllFireWands) { +    "wrong_tool": { 
-    WAND_USED.trigger(player, "fire"); // The string here is whatever we initiated the condition with. +      "conditions": { 
-} +        "amount": 5 
-if (playerUsedAllWaterWands) { +      }, 
-    WAND_USED.trigger(player, "water"); // The string here is whatever we initiated the condition with. +      "trigger": "minecraft:your_unique_mod_id_change_me_please/wrong_tool" 
-} +    } 
-if (playerUsedAllIceWands) { +  }, 
-    WAND_USED.trigger(player, "ice"); // The string here is whatever we initiated the condition with.+  // ... (Rest of JSON)
 } }
 </code> </code>
tutorial/datagen_advancements.1671843022.txt.gz · Last modified: 2022/12/24 00:50 by jmanc3