diff --git a/src/main/java/net/minecraftforge/client/event/RegisterParticleProvidersEvent.java b/src/main/java/net/minecraftforge/client/event/RegisterParticleProvidersEvent.java index eacb569436..4fc92d9bed 100644 --- a/src/main/java/net/minecraftforge/client/event/RegisterParticleProvidersEvent.java +++ b/src/main/java/net/minecraftforge/client/event/RegisterParticleProvidersEvent.java @@ -7,6 +7,7 @@ package net.minecraftforge.client.event; import net.minecraft.client.particle.ParticleEngine; import net.minecraft.client.particle.ParticleProvider; +import net.minecraft.client.particle.TextureSheetParticle; import net.minecraft.core.particles.ParticleOptions; import net.minecraft.core.particles.ParticleType; import net.minecraftforge.eventbus.api.Cancelable; @@ -39,38 +40,109 @@ public class RegisterParticleProvidersEvent extends Event implements IModBusEven } /** - * Registers a ParticleProvider for a non-json-based ParticleType. - * These particles do not receive a list of texture sprites to use for rendering themselves. + *
Registers a ParticleProvider for a non-json-based ParticleType. + * These particles do not receive a list of texture sprites to use for rendering themselves.
+ * + *There must be no particle json with an ID matching the ParticleType, + * or a redundant texture list error will occur when particle jsons load.
+ * * @paramRegisters a ParticleProvider for a non-json-based ParticleType. + * These particles do not receive a list of texture sprites to use for rendering themselves.
+ * + * There must be no particle json with an ID matching the ParticleType, + * or a redundant texture list error will occur when particle jsons load. + * + * @paramRegisters a ParticleProvider for a json-based ParticleType with a single texture; + * the resulting {@link TextureSheetParticle}s will use that texture when created.
+ * + *A particle json with an ID matching the ParticleType must exist in the particles asset folder,
+ * or a missing texture list error will occur when particle jsons load.
Registers a ParticleProvider for a json-based ParticleType with a single texture; + * the resulting {@link TextureSheetParticle}s will use that texture when created.
+ * + *A particle json with an ID matching the ParticleType must exist in the particles asset folder,
+ * or a missing texture list error will occur when particle jsons load.
particles asset folder,
- * or a missing texture list error will occur when particle jsons load.
- * @param registration SpriteParticleRegistration responsible for providing that ParticleType's particles.
+ * @param sprite Sprite function responsible for providing that ParticleType's particles.
+ * @see #registerSprite
+ * @deprecated Renamed to {@link #registerSprite}
+ */
+ @Deprecated(forRemoval = true, since = "1.19.4")
+ public Registers a ParticleProvider for a json-based ParticleType. + * Particle jsons define a list of texture sprites which the particle can use to render itself.
+ * + *A particle json with an ID matching the ParticleType must exist in the particles asset folder,
+ * or a missing texture list error will occur when particle jsons load.
Registers a ParticleProvider for a json-based ParticleType. + * Particle jsons define a list of texture sprites which the particle can use to render itself.
+ * + *A particle json with an ID matching the ParticleType must exist in the particles asset folder,
+ * or a missing texture list error will occur when particle jsons load.