From a8e68328c4f521ef5b6d406d5d850b1156457a3f Mon Sep 17 00:00:00 2001 From: David Quintana Date: Sat, 8 Aug 2020 02:59:00 +0200 Subject: [PATCH] Move ModelRegistryEvent invocation to when the model loading is about to start. Freeze the ModelLoaderRegistry right after this event happens, just before model loading actually begins. This means ModelRegistryEvent is now the correct place to register loaders, as it was intended. This is a slight breaking change, but any mod that used FMLClientSetupEvent before will need to be updated regardless due to the existing race condition. --- .../renderer/model/ModelBakery.java.patch | 17 +++++++++-------- .../client/event/ModelRegistryEvent.java | 2 +- .../client/model/ModelLoaderRegistry.java | 10 ++++++++-- .../fml/client/ClientModLoader.java | 3 --- .../debug/client/model/NewModelLoaderTest.java | 5 +++-- 5 files changed, 21 insertions(+), 16 deletions(-) diff --git a/patches/minecraft/net/minecraft/client/renderer/model/ModelBakery.java.patch b/patches/minecraft/net/minecraft/client/renderer/model/ModelBakery.java.patch index 4f3cec0712..83836a3e94 100644 --- a/patches/minecraft/net/minecraft/client/renderer/model/ModelBakery.java.patch +++ b/patches/minecraft/net/minecraft/client/renderer/model/ModelBakery.java.patch @@ -1,6 +1,6 @@ --- a/net/minecraft/client/renderer/model/ModelBakery.java +++ b/net/minecraft/client/renderer/model/ModelBakery.java -@@ -146,8 +146,16 @@ +@@ -146,8 +146,17 @@ }); public ModelBakery(IResourceManager p_i226056_1_, BlockColors p_i226056_2_, IProfiler p_i226056_3_, int p_i226056_4_) { @@ -14,10 +14,11 @@ + } + + protected void processLoading(IProfiler p_i226056_3_, int p_i226056_4_) { ++ net.minecraftforge.client.model.ModelLoaderRegistry.onModelLoadingStart(); p_i226056_3_.func_76320_a("missing_model"); try { -@@ -180,12 +188,16 @@ +@@ -180,12 +189,16 @@ p_i226056_3_.func_219895_b("special"); this.func_217843_a(new ModelResourceLocation("minecraft:trident_in_hand#inventory")); @@ -34,7 +35,7 @@ set.stream().filter((p_229346_0_) -> { return !p_229346_0_.getSecond().equals(field_229321_r_); }).forEach((p_229330_0_) -> { -@@ -224,6 +236,7 @@ +@@ -224,6 +237,7 @@ try { ibakedmodel = this.func_217845_a(p_229350_1_, ModelRotation.X0_Y0); } catch (Exception exception) { @@ -42,7 +43,7 @@ field_177603_c.warn("Unable to bake model: '{}': {}", p_229350_1_, exception); } -@@ -442,6 +455,13 @@ +@@ -442,6 +456,13 @@ this.field_217848_D.addAll(p_209593_2_.func_187965_e()); } @@ -56,7 +57,7 @@ private void func_217843_a(ModelResourceLocation p_217843_1_) { IUnbakedModel iunbakedmodel = this.func_209597_a(p_217843_1_); this.field_217849_F.put(p_217843_1_, iunbakedmodel); -@@ -456,7 +476,13 @@ +@@ -456,7 +477,13 @@ } @Nullable @@ -70,7 +71,7 @@ Triple triple = Triple.of(p_217845_1_, p_217845_2_.func_225615_b_(), p_217845_2_.func_188049_c()); if (this.field_217850_G.containsKey(triple)) { return this.field_217850_G.get(triple); -@@ -467,11 +493,11 @@ +@@ -467,11 +494,11 @@ if (iunbakedmodel instanceof BlockModel) { BlockModel blockmodel = (BlockModel)iunbakedmodel; if (blockmodel.func_178310_f() == field_177606_o) { @@ -84,7 +85,7 @@ this.field_217850_G.put(triple, ibakedmodel); return ibakedmodel; } -@@ -524,6 +550,10 @@ +@@ -524,6 +551,10 @@ return this.field_225367_M; } @@ -95,7 +96,7 @@ @OnlyIn(Dist.CLIENT) static class BlockStateDefinitionException extends RuntimeException { public BlockStateDefinitionException(String p_i49526_1_) { -@@ -531,6 +561,10 @@ +@@ -531,6 +562,10 @@ } } diff --git a/src/main/java/net/minecraftforge/client/event/ModelRegistryEvent.java b/src/main/java/net/minecraftforge/client/event/ModelRegistryEvent.java index 39649d27a9..cef96c0354 100644 --- a/src/main/java/net/minecraftforge/client/event/ModelRegistryEvent.java +++ b/src/main/java/net/minecraftforge/client/event/ModelRegistryEvent.java @@ -23,7 +23,7 @@ import net.minecraftforge.eventbus.api.Event; import net.minecraftforge.fml.event.lifecycle.IModBusEvent; /** - * Fired when the {@link net.minecraftforge.client.model.ModelLoader} is ready to receive registrations + * Fired when the {@link net.minecraftforge.client.model.ModelLoader} is ready to register model loaders */ public class ModelRegistryEvent extends Event implements IModBusEvent { diff --git a/src/main/java/net/minecraftforge/client/model/ModelLoaderRegistry.java b/src/main/java/net/minecraftforge/client/model/ModelLoaderRegistry.java index ea424c8224..6926dafb25 100644 --- a/src/main/java/net/minecraftforge/client/model/ModelLoaderRegistry.java +++ b/src/main/java/net/minecraftforge/client/model/ModelLoaderRegistry.java @@ -36,6 +36,7 @@ import net.minecraft.util.Direction; import net.minecraft.util.JSONUtils; import net.minecraft.util.ResourceLocation; import net.minecraft.util.math.vector.TransformationMatrix; +import net.minecraftforge.client.event.ModelRegistryEvent; import net.minecraftforge.client.model.geometry.IModelGeometry; import net.minecraftforge.client.model.geometry.ISimpleModelGeometry; import net.minecraftforge.client.model.obj.OBJLoader; @@ -76,18 +77,23 @@ public class ModelLoaderRegistry //registerLoader(new ResourceLocation("forge:fluid"), new ModelLoaderAdapter(ModelFluid.FluidLoader.INSTANCE)); } - public static void initComplete() + /** + * INTERNAL METHOD, DO NOT CALL + */ + public static void onModelLoadingStart() { + net.minecraftforge.fml.ModLoader.get().postEvent(new net.minecraftforge.client.event.ModelRegistryEvent()); registryFrozen = true; } /** * Makes system aware of your loader. + * Must be called from within {@link ModelRegistryEvent} */ public static void registerLoader(ResourceLocation id, IModelLoader loader) { if (registryFrozen) - throw new IllegalStateException("Can not register model loaders after models have started loading. Please use FMLClientSetupEvent or ModelRegistryEvent to register your loaders."); + throw new IllegalStateException("Can not register model loaders after models have started loading. Please use ModelRegistryEvent to register your loaders."); synchronized(loaders) { diff --git a/src/main/java/net/minecraftforge/fml/client/ClientModLoader.java b/src/main/java/net/minecraftforge/fml/client/ClientModLoader.java index e1ad46278f..6ac4e79cf2 100644 --- a/src/main/java/net/minecraftforge/fml/client/ClientModLoader.java +++ b/src/main/java/net/minecraftforge/fml/client/ClientModLoader.java @@ -48,7 +48,6 @@ import net.minecraft.resources.data.PackMetadataSection; import net.minecraft.util.text.TranslationTextComponent; import net.minecraftforge.api.distmarker.Dist; import net.minecraftforge.api.distmarker.OnlyIn; -import net.minecraftforge.client.event.ModelRegistryEvent; import net.minecraftforge.client.model.ModelLoaderRegistry; import net.minecraftforge.common.ForgeConfig; import net.minecraftforge.common.MinecraftForge; @@ -122,11 +121,9 @@ public class ClientModLoader private static void postSidedRunnable(Consumer> perModContainerEventProcessor) { RenderingRegistry.loadEntityRenderers(mc.getRenderManager()); - ModelLoaderRegistry.initComplete(); } private static void preSidedRunnable(Consumer> perModContainerEventProcessor) { - perModContainerEventProcessor.accept(ModelRegistryEvent::new); } private static void finishModLoading(Executor executor) diff --git a/src/test/java/net/minecraftforge/debug/client/model/NewModelLoaderTest.java b/src/test/java/net/minecraftforge/debug/client/model/NewModelLoaderTest.java index c9311cffac..b87772b5c6 100644 --- a/src/test/java/net/minecraftforge/debug/client/model/NewModelLoaderTest.java +++ b/src/test/java/net/minecraftforge/debug/client/model/NewModelLoaderTest.java @@ -45,6 +45,7 @@ import net.minecraft.util.math.BlockPos; import net.minecraft.util.math.shapes.ISelectionContext; import net.minecraft.util.math.shapes.VoxelShape; import net.minecraft.world.IBlockReader; +import net.minecraftforge.client.event.ModelRegistryEvent; import net.minecraftforge.client.model.IModelBuilder; import net.minecraftforge.client.model.IModelConfiguration; import net.minecraftforge.client.model.IModelLoader; @@ -134,10 +135,10 @@ public class NewModelLoaderTest BLOCKS.register(modEventBus); ITEMS.register(modEventBus); - modEventBus.addListener(this::clientSetup); + modEventBus.addListener(this::modelRegistry); } - public void clientSetup(FMLClientSetupEvent event) + public void modelRegistry(ModelRegistryEvent event) { ModelLoaderRegistry.registerLoader(new ResourceLocation(MODID, "custom_loader"), new TestLoader()); }