Package net.neoforged.neoforge.client.event

Class RegisterParticleGroupsEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterParticleGroupsEvent

All Implemented Interfaces:

IModBusEvent

public class RegisterParticleGroupsEvent
extends net.neoforged.bus.api.Event
implements IModBusEvent

Fired for registering additional particle group factories.

This is used when creating particle groups for particles in ParticleEngine.

This event is fired on the mod-specific event bus, only on the logical client.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ParticleRenderType,Function<ParticleEngine,ParticleGroup<?>>>	particleGroupFactories
private final List<ParticleRenderType>	particleRenderOrder

Constructor Summary

Constructors

Constructor	Description
RegisterParticleGroupsEvent(Map<ParticleRenderType,Function<ParticleEngine,ParticleGroup<?>>> particleGroupFactories, List<ParticleRenderType> particleRenderOrder)

Method Summary

Modifier and Type	Method	Description
void	register(ParticleRenderType group, Function<ParticleEngine,ParticleGroup<?>> factory)	Registers a factory function for the given particle group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

particleGroupFactories

private final Map<ParticleRenderType,Function<ParticleEngine,ParticleGroup<?>>> particleGroupFactories

particleRenderOrder

private final List<ParticleRenderType> particleRenderOrder

Constructor Details

RegisterParticleGroupsEvent

@Internal
public RegisterParticleGroupsEvent(Map<ParticleRenderType,Function<ParticleEngine,ParticleGroup<?>>> particleGroupFactories,
 List<ParticleRenderType> particleRenderOrder)

Method Details

register

public void register(ParticleRenderType group,
 Function<ParticleEngine,ParticleGroup<?>> factory)

Registers a factory function for the given particle group.

Parameters:

group - The particle group to register for.

factory - A factory function used to create the ParticleGroup.

Throws:

IllegalArgumentException - when a factory has already been registered for group.