Fix research cost list serialization in network buffers [1.20] (ldtte…

…am#9635)

Fix issues surrounding cost serialization to network buffers (and NBT)

src/api/java/com/minecolonies/api/IMinecoloniesAPI.java

@@ -23,7 +23,7 @@
 import com.minecolonies.api.entity.pathfinding.registry.IPathNavigateRegistry;
 import com.minecolonies.api.quests.registries.QuestRegistries;
 import com.minecolonies.api.research.IGlobalResearchTree;
-import com.minecolonies.api.research.ModResearchCosts;
+import com.minecolonies.api.research.ModResearchCostTypes.ResearchCostType;
 import com.minecolonies.api.research.effects.registry.ResearchEffectEntry;
 import com.minecolonies.api.research.registry.ResearchRequirementEntry;
 import net.minecraftforge.registries.IForgeRegistry;
@@ -74,7 +74,7 @@ static IMinecoloniesAPI getInstance()
 
     IForgeRegistry<ResearchEffectEntry> getResearchEffectRegistry();
 
-    IForgeRegistry<ModResearchCosts.ResearchCostEntry> getResearchCostRegistry();
+    IForgeRegistry<ResearchCostType> getResearchCostRegistry();
 
     IForgeRegistry<ColonyEventTypeRegistryEntry> getColonyEventRegistry();
 

src/api/java/com/minecolonies/api/MinecoloniesAPIProxy.java

@@ -23,7 +23,7 @@
 import com.minecolonies.api.entity.pathfinding.registry.IPathNavigateRegistry;
 import com.minecolonies.api.quests.registries.QuestRegistries;
 import com.minecolonies.api.research.IGlobalResearchTree;
-import com.minecolonies.api.research.ModResearchCosts;
+import com.minecolonies.api.research.ModResearchCostTypes.ResearchCostType;
 import com.minecolonies.api.research.effects.registry.ResearchEffectEntry;
 import com.minecolonies.api.research.registry.ResearchRequirementEntry;
 import net.minecraftforge.registries.IForgeRegistry;
@@ -157,7 +157,7 @@ public IGlobalResearchTree getGlobalResearchTree()
     public IForgeRegistry<ResearchEffectEntry> getResearchEffectRegistry() {return apiInstance.getResearchEffectRegistry();}
 
     @Override
-    public IForgeRegistry<ModResearchCosts.ResearchCostEntry> getResearchCostRegistry()
+    public IForgeRegistry<ResearchCostType> getResearchCostRegistry()
     {
         return apiInstance.getResearchCostRegistry();
     }

src/api/java/com/minecolonies/api/research/AbstractResearchProvider.java

@@ -20,12 +20,11 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
-
-import static com.minecolonies.api.research.ModResearchCosts.LIST_ITEM_COST_ID;
-import static com.minecolonies.api.research.ModResearchCosts.TAG_ITEM_COST_ID;
-import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
+import static com.minecolonies.api.research.ModResearchCostTypes.LIST_ITEM_COST_ID;
+import static com.minecolonies.api.research.ModResearchCostTypes.TAG_ITEM_COST_ID;
+
 /**
  * A class for creating the Research-related JSONs, including Research, ResearchEffects, and (optional) Branches.
  * Note that this does not validate that the resulting research tree is coherent:

src/api/java/com/minecolonies/api/research/ModResearchCosts.java → src/api/java/com/minecolonies/api/research/ModResearchCostTypes.java

@@ -6,49 +6,65 @@
 import net.minecraft.resources.ResourceLocation;
 import net.minecraftforge.registries.RegistryObject;
 
-import java.util.function.Supplier;
+import java.util.function.Function;
 
 /**
  * Registry entries for item cost types.
  */
-public class ModResearchCosts
+public class ModResearchCostTypes
 {
     public static final ResourceLocation SIMPLE_ITEM_COST_ID = new ResourceLocation(Constants.MOD_ID, "item_simple");
     public static final ResourceLocation LIST_ITEM_COST_ID   = new ResourceLocation(Constants.MOD_ID, "item_list");
     public static final ResourceLocation TAG_ITEM_COST_ID    = new ResourceLocation(Constants.MOD_ID, "item_tag");
 
-    public static RegistryObject<ResearchCostEntry> simpleItemCost;
+    public static RegistryObject<ResearchCostType> simpleItemCost;
 
-    public static RegistryObject<ResearchCostEntry> listItemCost;
+    public static RegistryObject<ResearchCostType> listItemCost;
 
-    public static RegistryObject<ResearchCostEntry> tagItemCost;
+    public static RegistryObject<ResearchCostType> tagItemCost;
 
     /**
      * Quest reward entry type.
      */
-    public static class ResearchCostEntry
+    public static class ResearchCostType
     {
+        /**
+         * The ID of the cost type.
+         */
+        private final ResourceLocation id;
+
         /**
          * The producer for the cost instance.
          */
-        private final Supplier<IResearchCost> producer;
+        private final Function<ResearchCostType, IResearchCost> producer;
 
         /**
          * Default constructor.
          */
-        public ResearchCostEntry(final Supplier<IResearchCost> productionFunction)
+        public ResearchCostType(final ResourceLocation id, final Function<ResearchCostType, IResearchCost> productionFunction)
         {
+            this.id = id;
             this.producer = productionFunction;
         }
 
+        /**
+         * The ID of this cost type.
+         *
+         * @return the id.
+         */
+        public ResourceLocation getId()
+        {
+            return id;
+        }
+
         /**
          * Create an empty cost instance.
          *
          * @return the cost instance.
          */
         public IResearchCost createInstance()
         {
-            return producer.get();
+            return producer.apply(this);
         }
 
         /**

src/api/java/com/minecolonies/api/research/costs/IResearchCost.java

@@ -1,10 +1,11 @@
 package com.minecolonies.api.research.costs;
 
 import com.google.gson.JsonObject;
+import com.minecolonies.api.research.ModResearchCostTypes.ResearchCostType;
 import net.minecraft.nbt.CompoundTag;
+import net.minecraft.network.FriendlyByteBuf;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.ComponentUtils;
-import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.Item;
 import org.jetbrains.annotations.NotNull;
 
@@ -16,11 +17,11 @@
 public interface IResearchCost
 {
     /**
-     * The ID for this cost.
+     * The type for this cost.
      *
-     * @return the id.
+     * @return the type.
      */
-    ResourceLocation getId();
+    ResearchCostType getType();
 
     /**
      * Get the count for this cost.
@@ -60,6 +61,20 @@ default Component getTranslatedName()
      */
     void write(@NotNull final CompoundTag compound);
 
+    /**
+     * Serialize the cost instance to the given {@link FriendlyByteBuf}.
+     *
+     * @param buf the network buffer.
+     */
+    void serialize(@NotNull final FriendlyByteBuf buf);
+
+    /**
+     * Deserialize the {@link FriendlyByteBuf} to this cost instance.
+     *
+     * @param buf the network buffer.
+     */
+    void deserialize(@NotNull final FriendlyByteBuf buf);
+
     /**
      * Checks if this json object has the correct fields for this cost instance.
      *

src/main/java/com/minecolonies/apiimp/CommonMinecoloniesAPIImpl.java

@@ -25,7 +25,7 @@
 import com.minecolonies.api.entity.pathfinding.registry.IPathNavigateRegistry;
 import com.minecolonies.api.quests.registries.QuestRegistries;
 import com.minecolonies.api.research.IGlobalResearchTree;
-import com.minecolonies.api.research.ModResearchCosts;
+import com.minecolonies.api.research.ModResearchCostTypes.ResearchCostType;
 import com.minecolonies.api.research.effects.registry.ResearchEffectEntry;
 import com.minecolonies.api.research.registry.ResearchRequirementEntry;
 import com.minecolonies.api.util.constant.Constants;
@@ -45,7 +45,7 @@
 import net.minecraftforge.registries.RegistryBuilder;
 import org.jetbrains.annotations.NotNull;
 
-import static com.minecolonies.api.research.ModResearchCosts.LIST_ITEM_COST_ID;
+import static com.minecolonies.api.research.ModResearchCostTypes.LIST_ITEM_COST_ID;
 import static com.minecolonies.api.research.ModResearchRequirements.RESEARCH_RESEARCH_REQ_ID;
 import static com.minecolonies.api.research.effects.ModResearchEffects.GLOBAL_EFFECT_ID;
 
@@ -69,7 +69,7 @@ public class CommonMinecoloniesAPIImpl implements IMinecoloniesAPI
     private static IGlobalResearchTree                                     globalResearchTree     = new GlobalResearchTree();
     private        IForgeRegistry<ResearchRequirementEntry>                researchRequirementRegistry;
     private        IForgeRegistry<ResearchEffectEntry>                     researchEffectRegistry;
-    private        IForgeRegistry<ModResearchCosts.ResearchCostEntry>      researchCostRegistry;
+    private        IForgeRegistry<ResearchCostType>                        researchCostRegistry;
     private        IForgeRegistry<RecipeTypeEntry>                         recipeTypeEntryRegistry;
     private        IForgeRegistry<CraftingType>                            craftingTypeRegistry;
     private        IForgeRegistry<QuestRegistries.ObjectiveEntry>          questObjectiveRegistry;
@@ -195,7 +195,7 @@ public IGlobalResearchTree getGlobalResearchTree()
     public IForgeRegistry<ResearchEffectEntry> getResearchEffectRegistry() {return researchEffectRegistry;}
 
     @Override
-    public IForgeRegistry<ModResearchCosts.ResearchCostEntry> getResearchCostRegistry()
+    public IForgeRegistry<ResearchCostType> getResearchCostRegistry()
     {
         return researchCostRegistry;
     }
@@ -274,7 +274,7 @@ public void onRegistryNewRegistry(final NewRegistryEvent event)
                        .disableSaving().allowModification()
                        .setIDRange(0, Integer.MAX_VALUE - 1), (b) -> researchEffectRegistry = b);
 
-        event.create(new RegistryBuilder<ModResearchCosts.ResearchCostEntry>()
+        event.create(new RegistryBuilder<ResearchCostType>()
                        .setName(new ResourceLocation(Constants.MOD_ID, "researchcosttypes"))
                        .setDefaultKey(LIST_ITEM_COST_ID)
                        .disableSaving().allowModification()

src/main/java/com/minecolonies/apiimp/initializer/ModResearchCostInitializer.java → src/main/java/com/minecolonies/apiimp/initializer/ModResearchCostTypeInitializer.java

@@ -1,34 +1,34 @@
 package com.minecolonies.apiimp.initializer;
 
-import com.minecolonies.api.research.ModResearchCosts;
+import com.minecolonies.api.research.ModResearchCostTypes;
 import com.minecolonies.api.util.constant.Constants;
 import com.minecolonies.coremod.research.costs.ListItemCost;
 import com.minecolonies.coremod.research.costs.SimpleItemCost;
 import com.minecolonies.coremod.research.costs.TagItemCost;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraftforge.registries.DeferredRegister;
 
-import static com.minecolonies.api.research.ModResearchCosts.*;
+import static com.minecolonies.api.research.ModResearchCostTypes.*;
 
 /**
- * Registry initializer for the {@link ModResearchCosts}.
+ * Registry initializer for the {@link ModResearchCostTypes}.
  */
-public class ModResearchCostInitializer
+public class ModResearchCostTypeInitializer
 {
-    public static final DeferredRegister<ModResearchCosts.ResearchCostEntry>
+    public static final DeferredRegister<ResearchCostType>
       DEFERRED_REGISTER = DeferredRegister.create(new ResourceLocation(Constants.MOD_ID, "researchcosttypes"), Constants.MOD_ID);
     static
     {
-        ModResearchCosts.simpleItemCost =
-          DEFERRED_REGISTER.register(SIMPLE_ITEM_COST_ID.getPath(), () -> new ModResearchCosts.ResearchCostEntry(SimpleItemCost::new));
+        ModResearchCostTypes.simpleItemCost =
+          DEFERRED_REGISTER.register(SIMPLE_ITEM_COST_ID.getPath(), () -> new ResearchCostType(SIMPLE_ITEM_COST_ID, SimpleItemCost::new));
 
-        ModResearchCosts.listItemCost =
-          DEFERRED_REGISTER.register(LIST_ITEM_COST_ID.getPath(), () -> new ModResearchCosts.ResearchCostEntry(ListItemCost::new));
+        ModResearchCostTypes.listItemCost =
+          DEFERRED_REGISTER.register(LIST_ITEM_COST_ID.getPath(), () -> new ResearchCostType(LIST_ITEM_COST_ID, ListItemCost::new));
 
-        ModResearchCosts.tagItemCost =
-          DEFERRED_REGISTER.register(TAG_ITEM_COST_ID.getPath(), () -> new ModResearchCosts.ResearchCostEntry(TagItemCost::new));
+        ModResearchCostTypes.tagItemCost =
+          DEFERRED_REGISTER.register(TAG_ITEM_COST_ID.getPath(), () -> new ResearchCostType(TAG_ITEM_COST_ID, TagItemCost::new));
     }
-    private ModResearchCostInitializer()
+    private ModResearchCostTypeInitializer()
     {
         throw new IllegalStateException("Tried to initialize: ModResearchCostInitializer but this is a Utility class.");
     }

src/main/java/com/minecolonies/coremod/MineColonies.java

@@ -32,6 +32,8 @@
 import com.minecolonies.coremod.proxy.IProxy;
 import com.minecolonies.coremod.proxy.ServerProxy;
 import com.minecolonies.coremod.structures.MineColoniesStructures;
+import net.minecraft.client.renderer.texture.TextureAtlas;
+import net.minecraft.resources.ResourceLocation;
 import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.common.MinecraftForge;
 import net.minecraftforge.common.capabilities.Capability;
@@ -90,7 +92,7 @@ public MineColonies()
         ModSoundEvents.SOUND_EVENTS.register(FMLJavaModLoadingContext.get().getModEventBus());
         ModInteractionsInitializer.DEFERRED_REGISTER.register(FMLJavaModLoadingContext.get().getModEventBus());
         ModResearchEffectInitializer.DEFERRED_REGISTER.register(FMLJavaModLoadingContext.get().getModEventBus());
-        ModResearchCostInitializer.DEFERRED_REGISTER.register(FMLJavaModLoadingContext.get().getModEventBus());
+        ModResearchCostTypeInitializer.DEFERRED_REGISTER.register(FMLJavaModLoadingContext.get().getModEventBus());
         ModLootConditions.DEFERRED_REGISTER.register(FMLJavaModLoadingContext.get().getModEventBus());
         SupplyLoot.GLM.register(FMLJavaModLoadingContext.get().getModEventBus());
         ModBannerPatterns.BANNER_PATTERNS.register(FMLJavaModLoadingContext.get().getModEventBus());

src/main/java/com/minecolonies/coremod/research/GlobalResearchFactory.java

@@ -6,7 +6,7 @@
 import com.minecolonies.api.colony.requestsystem.factory.IFactoryController;
 import com.minecolonies.api.research.IGlobalResearch;
 import com.minecolonies.api.research.IResearchRequirement;
-import com.minecolonies.api.research.ModResearchCosts;
+import com.minecolonies.api.research.ModResearchCostTypes.ResearchCostType;
 import com.minecolonies.api.research.costs.IResearchCost;
 import com.minecolonies.api.research.effects.IResearchEffect;
 import com.minecolonies.api.research.effects.registry.IResearchEffectRegistry;
@@ -27,7 +27,7 @@
 
 import java.util.Objects;
 
-import static com.minecolonies.api.research.ModResearchCosts.SIMPLE_ITEM_COST_ID;
+import static com.minecolonies.api.research.ModResearchCostTypes.SIMPLE_ITEM_COST_ID;
 import static com.minecolonies.api.research.util.ResearchConstants.*;
 
 /**
@@ -78,10 +78,9 @@ public CompoundTag serialize(@NotNull final IFactoryController controller, @NotN
         compound.putBoolean(TAG_HIDDEN, research.isHidden());
         @NotNull final ListTag costTagList = research.getCostList().stream().map(cost ->
         {
-            final ModResearchCosts.ResearchCostEntry researchCostEntry = IMinecoloniesAPI.getInstance().getResearchCostRegistry().getValue(cost.getId());
-            final IResearchCost instance = researchCostEntry.createInstance();
-            compound.putString(TAG_COST_TYPE, cost.getId().toString());
-            instance.write(compound);
+            final CompoundTag costCompound = new CompoundTag();
+            costCompound.putString(TAG_COST_TYPE, cost.getType().getId().toString());
+            cost.write(costCompound);
             return compound;
         }).collect(NBTUtils.toListNBT());
         compound.put(TAG_COSTS, costTagList);
@@ -141,8 +140,8 @@ public IGlobalResearch deserialize(@NotNull final IFactoryController controller,
         NBTUtils.streamCompound(nbt.getList(TAG_COSTS, Tag.TAG_COMPOUND)).forEach(compound ->
         {
             final ResourceLocation res = compound.contains(TAG_COST_TYPE) ? new ResourceLocation(compound.getString(TAG_COST_TYPE)) : SIMPLE_ITEM_COST_ID;
-            final ModResearchCosts.ResearchCostEntry researchCostEntry = IMinecoloniesAPI.getInstance().getResearchCostRegistry().getValue(res);
-            final IResearchCost instance = researchCostEntry.createInstance();
+            final ResearchCostType researchCostType = IMinecoloniesAPI.getInstance().getResearchCostRegistry().getValue(res);
+            final IResearchCost instance = researchCostType.createInstance();
             instance.read(compound);
             research.addCost(instance);
         });
@@ -177,9 +176,10 @@ public void serialize(@NotNull IFactoryController controller, IGlobalResearch in
         packetBuffer.writeBoolean(input.isImmutable());
         packetBuffer.writeBoolean(input.isHidden());
         packetBuffer.writeVarInt(input.getCostList().size());
-        for (IResearchCost is : input.getCostList())
+        for (IResearchCost cost : input.getCostList())
         {
-            controller.serialize(packetBuffer, is);
+            packetBuffer.writeRegistryId(IMinecoloniesAPI.getInstance().getResearchCostRegistry(), cost.getType());
+            cost.serialize(packetBuffer);
         }
         packetBuffer.writeVarInt(input.getResearchRequirement().size());
         for (IResearchRequirement req : input.getResearchRequirement())
@@ -224,7 +224,10 @@ public IGlobalResearch deserialize(@NotNull IFactoryController controller, Frien
         final int costSize = buffer.readVarInt();
         for(int i = 0; i < costSize; i++)
         {
-            research.addCost(controller.deserialize(buffer));
+            final ResearchCostType researchCostType = buffer.readRegistryIdSafe(ResearchCostType.class);
+            final IResearchCost cost = researchCostType.createInstance();
+            cost.deserialize(buffer);
+            research.addCost(cost);
         }
 
         final int reqCount = buffer.readVarInt();