Dynamic Loot Modification - Revision history

ChampionAsh5357: Fix the explanation

2022-09-20T18:30:03Z

Fix the explanation

Nexus-Dino: Update to 1.19 Codec GLMs

2022-09-20T17:52:56Z

Update to 1.19 Codec GLMs

ChampionAsh5357: Update to 1.19

2022-06-18T15:00:52Z

Update to 1.19

ChampionAsh5357: Update to 1.17

2021-08-02T22:01:46Z

Update to 1.17

Curle: Formatting adjust?

2021-07-30T13:57:30Z

Formatting adjust?

Curle: Formatting adjust?

2021-07-30T13:57:09Z

Formatting adjust?

Curle: Move qualification into a tip box.

2021-07-30T13:55:58Z

Move qualification into a tip box.

Curle: Qualify where seedItem, numSeeds and replacement come from.

2021-07-30T13:53:15Z

Qualify where seedItem, numSeeds and replacement come from.

Tslat: /* The global_loot_modifiers.json */

2021-05-09T19:07:36Z

The global_loot_modifiers.json

Tslat: /* The global_loot_modifiers.json */

2021-05-09T19:07:23Z

The global_loot_modifiers.json

@@ Line 9: / Line 9: @@
 #* This will contain all of the data about your modification and allows data packs to tweak your effect.
 # A class that extends <code>LootModifier</code>
-#* The operational code that makes your modifier work and associated serializer.
+#* The operational code that makes your modifier work and associated codec.
-Finally, the serializer for your operational class is [[Registration|registered]] as any other registry object.
+Finally, the codec for your operational class is [[Registration|registered]] as any other registry object.
 ==The global_loot_modifiers.json==
@@ Line 66: / Line 66: @@
 == The LootModifier Subclass ==
-You will also need a static child class that extends <code>GlobalLootModifierSerializer<T></code> where <code>T</code> is your LootModifier subclass in order to deserialize your json data file into operational code.
+You will also need a <code>Codec<T></code> where <code>T</code> is your LootModifier subclass in order to deserialize your json data file into operational code. The codec must be [[Registration|registered]].
 <syntaxhighlight lang="java">
@@ Line 74: / Line 74: @@
+      *
       */
 private static class WheatSeedsConverterModifier extends LootModifier
+{
-         public static final Supplier<Codec<WheatSeedsConverterModifier>> CODEC = Suppliers.memoize(() ->
+         public static final RegistryObject<Codec<WheatSeedsConverterModifier>> CODEC = LOOT_MODIFIER_REGISTRAR.register("wheat_seeds_converter", () ->
          RecordCodecBuilder.create(inst -> codecStart(inst).and(
                  inst.group(
@@ Line 128: / Line 129: @@
 This method is only called if the <code>conditions</code> specified return <code>true</code> and the modder is now able to make the modifications they desire. In this case we can see that the number of <code>itemToCheck</code> meets or exceeds the <code>numSeedsToConvert</code> before modifying the list by adding an <code>itemReward</code> and removing any excess <code>itemToCheck</code> stacks, matching the previously mentioned effects: ''When a wheat block is harvested with shears, if enough seeds are generated as loot, they are converted to additional wheat instead''.
-Utilize <code>GlobalLootModifierProvider</code> for [[datageneration|data generation]].
+The codec can also be used for [[datageneration|data generation]] with a <code>GlobalLootModifierProvider</code>.
 Additional [https://github.com/MinecraftForge/MinecraftForge/blob/1.19.x/src/test/java/net/minecraftforge/debug/gameplay/loot/GlobalLootModifiersTest.java examples] can be found on the Forge Git repository, including silk touch and smelting effects.

@@ Line 11: / Line 11: @@
 #* The operational code that makes your modifier work and associated serializer.
-Finally, the serializer for your operational class is [[Registration|registered]] as any other <code>ForgeRegistryEntry</code>.
+Finally, the serializer for your operational class is [[Registration|registered]] as any other registry object.
 ==The global_loot_modifiers.json==
@@ Line 69: / Line 69: @@
 <syntaxhighlight lang="java">
-private static class WheatSeedsConverterModifier extends LootModifier {
+/**
-  private final int numSeedsToConvert;
+     * When harvesting wheat with shears, this modifier is invoked via the wheat_harvest loot_modifier json<br/>
-  private final Item itemToCheck;
+      * This modifier checks how many seeds were harvested and turns X seeds into Y wheat (3:1)
-  private final Item itemReward;
       */
-    int numSeeds = 0;
+private static class WheatSeedsConverterModifier extends LootModifier
-    for(ItemStack stack : generatedLoot) {
-      if(stack.getItem() == itemToCheck)
+        public static final Supplier<Codec<WheatSeedsConverterModifier>> CODEC = Suppliers.memoize(() ->
-         numSeeds += stack.getCount();
+         RecordCodecBuilder.create(inst -> codecStart(inst).and(
+                inst.group(
-    if(numSeeds >= numSeedsToConvert) {
+                        Codec.INT.fieldOf("numSeeds").forGetter(m -> m.numSeedsToConvert),
-      generatedLoot.removeIf(x -> x.getItem() == itemToCheck);
+                        ForgeRegistries.ITEMS.getCodec().fieldOf("seedItem").forGetter(m -> m.itemToCheck),
-      generatedLoot.add(new ItemStack(itemReward, (numSeeds/numSeedsToConvert)));
+                        ForgeRegistries.ITEMS.getCodec().fieldOf("replacement").forGetter(m -> m.itemReward)
-      numSeeds = numSeeds % numSeedsToConvert;
+                )).apply(inst, WheatSeedsConverterModifier::new)
-      if(numSeeds > 0)
+         ));
-  private static class Serializer extends GlobalLootModifierSerializer<WheatSeedsConverterModifier> {
+        private final int numSeedsToConvert;
-    @Override
+        @NotNull
-    public WheatSeedsConverterModifier read(ResourceLocation name, JsonObject object, LootItemCondition[] conditions) {
+        @Override
-      int numSeeds = GsonHelper.getAsInt(object, "numSeeds");
+        public ObjectArrayList<ItemStack> doApply(ObjectArrayList<ItemStack> generatedLoot, LootContext context) {
-      Item seed = ForgeRegistries.ITEMS.getValue(new ResourceLocation((GsonHelper.getAsString(object, "seedItem"))));
+            //
-      Item wheat = ForgeRegistries.ITEMS.getValue(new ResourceLocation(GsonHelper.getAsString(object, "replacement")));
+            // Additional conditions can be checked, though as much as possible should be parameterized via JSON data.
-      return new WheatSeedsConverterModifier(conditions, numSeeds, seed, wheat);
+            // It is better to write a new ILootCondition implementation than to do things here.
+            //
-    @Override
+        @Override
-    public JsonObject write(WheatSeedsConverterModifier instance) {
+        public Codec<? extends IGlobalLootModifier> codec() {
-      JsonObject json = makeConditions(instance.conditions);
+            return CODEC.get();
-      json.addProperty("numSeeds", instance.numSeedsToConvert);
+     }
 </syntaxhighlight>
@@ Line 128: / Line 128: @@
 This method is only called if the <code>conditions</code> specified return <code>true</code> and the modder is now able to make the modifications they desire. In this case we can see that the number of <code>itemToCheck</code> meets or exceeds the <code>numSeedsToConvert</code> before modifying the list by adding an <code>itemReward</code> and removing any excess <code>itemToCheck</code> stacks, matching the previously mentioned effects: ''When a wheat block is harvested with shears, if enough seeds are generated as loot, they are converted to additional wheat instead''.
-Also take note of the <code>read</code> method in the serializer. The conditions are already deserialized for you and if you have no other data, simply <code>return new MyModifier(conditions)</code>. However, the full <code>JsonObject</code> is available if needed. The <code>write</code> method, on the other hand, is used for if you want to utilize <code>GlobalLootModifierProvider</code> for [[datageneration|data generation]].
+Utilize <code>GlobalLootModifierProvider</code> for [[datageneration|data generation]].
 Additional [https://github.com/MinecraftForge/MinecraftForge/blob/1.19.x/src/test/java/net/minecraftforge/debug/gameplay/loot/GlobalLootModifiersTest.java examples] can be found on the Forge Git repository, including silk touch and smelting effects.

← Older revision		Revision as of 15:00, 18 June 2022
Line 130:		Line 130:
	Also take note of the <code>read</code> method in the serializer. The conditions are already deserialized for you and if you have no other data, simply <code>return new MyModifier(conditions)</code>. However, the full <code>JsonObject</code> is available if needed. The <code>write</code> method, on the other hand, is used for if you want to utilize <code>GlobalLootModifierProvider</code> for [[datageneration\|data generation]].		Also take note of the <code>read</code> method in the serializer. The conditions are already deserialized for you and if you have no other data, simply <code>return new MyModifier(conditions)</code>. However, the full <code>JsonObject</code> is available if needed. The <code>write</code> method, on the other hand, is used for if you want to utilize <code>GlobalLootModifierProvider</code> for [[datageneration\|data generation]].

−	Additional [https://github.com/MinecraftForge/MinecraftForge/blob/1.17.x/src/test/java/net/minecraftforge/debug/gameplay/loot/GlobalLootModifiersTest.java examples] can be found on the Forge Git repository, including silk touch and smelting effects.	+	Additional [https://github.com/MinecraftForge/MinecraftForge/blob/1.19.x/src/test/java/net/minecraftforge/debug/gameplay/loot/GlobalLootModifiersTest.java examples] can be found on the Forge Git repository, including silk touch and smelting effects.

@@ Line 45: / Line 45: @@
      },
+     {
-       "condition": "block_state_property",
+       "condition": "minecraft:block_state_property",
-       "block":"minecraft:wheat"
+       "block": "minecraft:wheat"
+     }
    ],
@@ Line 70: / Line 70: @@
 <syntaxhighlight lang="java">
 private static class WheatSeedsConverterModifier extends LootModifier {
-	private final int numSeedsToConvert;
+  private final int numSeedsToConvert;
-	private final Item itemToCheck;
+  private final Item itemToCheck;
-	private final Item itemReward;
+  private final Item itemReward;
-	public WheatSeedsConverterModifier(ILootCondition[] conditionsIn, int numSeeds, Item itemCheck, Item reward) {
+  public WheatSeedsConverterModifier(LootItemCondition[] conditions, int numSeeds, Item itemCheck, Item reward) {
-		super(conditionsIn);
+    super(conditions);
-		numSeedsToConvert = numSeeds;
+    numSeedsToConvert = numSeeds;
-		itemToCheck = itemCheck;
+    itemToCheck = itemCheck;
-		itemReward = reward;
+    itemReward = reward;
-−
+  }
-	@Nonnull
+  @Nonnull
-	@Override
+  @Override
-	public List<ItemStack> doApply(List<ItemStack> generatedLoot, LootContext context) {
+  public List<ItemStack> doApply(List<ItemStack> generatedLoot, LootContext context) {
-		/*
+    /*
-		* Additional conditions can be checked, though as much as possible should be parameterized via JSON data.
+     * Additional conditions can be checked, though as much as possible should be parameterized via JSON data.
-		* It is better to write a new ILootCondition implementation than to do things here.
+     * It is better to write a new LootItemCondition implementation than to do things here.
-		*/
+     */
-		int numSeeds = 0;
+    int numSeeds = 0;
-		for(ItemStack stack : generatedLoot) {
+    for(ItemStack stack : generatedLoot) {
-			if(stack.getItem() == itemToCheck)
+      if(stack.getItem() == itemToCheck)
-				numSeeds+=stack.getCount();
+        numSeeds += stack.getCount();
-−
+    }
-		if(numSeeds >= numSeedsToConvert) {
+    if(numSeeds >= numSeedsToConvert) {
-			generatedLoot.removeIf(x -> x.getItem() == itemToCheck);
+      generatedLoot.removeIf(x -> x.getItem() == itemToCheck);
-			generatedLoot.add(new ItemStack(itemReward, (numSeeds/numSeedsToConvert)));
+      generatedLoot.add(new ItemStack(itemReward, (numSeeds/numSeedsToConvert)));
-			numSeeds = numSeeds%numSeedsToConvert;
+      numSeeds = numSeeds % numSeedsToConvert;
-			if(numSeeds > 0)
+      if(numSeeds > 0)
-				generatedLoot.add(new ItemStack(itemToCheck, numSeeds));
+        generatedLoot.add(new ItemStack(itemToCheck, numSeeds));
-−
+    }
-		return generatedLoot;
+    return generatedLoot;
-−
+  }
-	private static class Serializer extends GlobalLootModifierSerializer<WheatSeedsConverterModifier> {
+  private static class Serializer extends GlobalLootModifierSerializer<WheatSeedsConverterModifier> {
-		@Override
+    @Override
-		public WheatSeedsConverterModifier read(ResourceLocation name, JsonObject object, ILootCondition[] conditionsIn) {
+    public WheatSeedsConverterModifier read(ResourceLocation name, JsonObject object, LootItemCondition[] conditions) {
-			int numSeeds = JSONUtils.getInt(object, "numSeeds");
+      int numSeeds = GsonHelper.getAsInt(object, "numSeeds");
-			Item seed = ForgeRegistries.ITEMS.getValue(new ResourceLocation((JSONUtils.getString(object, "seedItem"))));
+      Item seed = ForgeRegistries.ITEMS.getValue(new ResourceLocation((GsonHelper.getAsString(object, "seedItem"))));
-			Item wheat = ForgeRegistries.ITEMS.getValue(new ResourceLocation(JSONUtils.getString(object, "replacement")));
+      Item wheat = ForgeRegistries.ITEMS.getValue(new ResourceLocation(GsonHelper.getAsString(object, "replacement")));
-			return new WheatSeedsConverterModifier(conditionsIn, numSeeds, seed, wheat);
+      return new WheatSeedsConverterModifier(conditions, numSeeds, seed, wheat);
-−
+    }
-−
+}
 </syntaxhighlight>
@@ Line 117: / Line 126: @@
 The critical portion is the <code>doApply</code> method.
-This method is only called if the <code>conditions</code> specified return <code>true</code> and the modder is now able to make the modifications they desire. In this case we can see that the number of <code>itemToCheck</code> meets or exceeds the <code>numSeedsToConvert</code> before modifying the list by adding an <code>itemReward</code> and removing any excess <code>itemToCheck</code> stacks, matching the previously mentioned effects: When a wheat block is harvested with shears, if enough seeds are generated as loot, they are converted to additional wheat instead.
+This method is only called if the <code>conditions</code> specified return <code>true</code> and the modder is now able to make the modifications they desire. In this case we can see that the number of <code>itemToCheck</code> meets or exceeds the <code>numSeedsToConvert</code> before modifying the list by adding an <code>itemReward</code> and removing any excess <code>itemToCheck</code> stacks, matching the previously mentioned effects: ''When a wheat block is harvested with shears, if enough seeds are generated as loot, they are converted to additional wheat instead''.
-Also take note of the <code>read</code> method in the serializer. The conditions are already deserialized for you and if you have no other data, simply <code>return new MyModifier(conditionsIn)</code>. However, the full <code>JsonObject</code> is available if needed.
+Also take note of the <code>read</code> method in the serializer. The conditions are already deserialized for you and if you have no other data, simply <code>return new MyModifier(conditions)</code>. However, the full <code>JsonObject</code> is available if needed. The <code>write</code> method, on the other hand, is used for if you want to utilize <code>GlobalLootModifierProvider</code> for [[datageneration|data generation]].
-Additional [https://github.com/MinecraftForge/MinecraftForge/blob/1.15.x/src/test/java/net/minecraftforge/debug/gameplay/loot/GlobalLootModifiersTest.java examples] can be found on the Forge Git repository, including silk touch and smelting effects.
+Additional [https://github.com/MinecraftForge/MinecraftForge/blob/1.17.x/src/test/java/net/minecraftforge/debug/gameplay/loot/GlobalLootModifiersTest.java examples] can be found on the Forge Git repository, including silk touch and smelting effects.

@@ Line 58: / Line 58: @@
 {{Tip|<code>conditions</code> is the only object needed by the system specification, everything else is the mod maker's data.
 <code>seedItem</code>, <code>numSeeds</code> and <code>replacement</code> are NOT standard elements of Global Loot Modifiers.
 They are deserialized manually in the next section.}}

@@ Line 57: / Line 57: @@
 In the above example, the modification only happens if the player harvests wheat when using shears (specified by the two <code>conditions</code> which are automatically <code>AND</code>ed together). The <code>seedsItem</code> and <code>numSeeds</code> values are then used to count how many seeds were generated by the vanilla loot table, and if matched, are substituted for an additional <code>replacement</code> item instead. The operation code will be shown below.
 {{Tip|<code>conditions</code> is the only object needed by the system specification, everything else is the mod maker's data. <code>seedItem</code>, <code>numSeeds</code> and <code>replacement</code> are NOT standard elements of Global Loot Modifiers.}}
 == The LootModifier Subclass ==

@@ Line 15: / Line 15: @@
 ==The global_loot_modifiers.json==
 All you need to add here are the file names of your loot modifiers.
 These are the names of the json files you have made in the loot_modifiers folder, in ResourceLocation format.
 <syntaxhighlight lang="json">