Package net.neoforged.neoforge.client.event

Class RegisterDimensionSpecialEffectsEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterDimensionSpecialEffectsEvent

All Implemented Interfaces:

net.neoforged.fml.event.IModBusEvent

public class RegisterDimensionSpecialEffectsEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.fml.event.IModBusEvent

Allows users to register custom DimensionSpecialEffects for their dimensions.

This event is not cancellable, and does not have a result.

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

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<ResourceLocation,DimensionSpecialEffects>	effects

Constructor Summary

Constructors

Constructor	Description
RegisterDimensionSpecialEffectsEvent(Map<ResourceLocation,DimensionSpecialEffects> effects)

Method Summary

Modifier and Type	Method	Description
void	register(ResourceLocation dimensionType, DimensionSpecialEffects effects)	Registers the effects for a given dimension type.

Methods inherited from class net.neoforged.bus.api.Event

getResult, hasResult, setResult

Methods inherited from class java.lang.Object

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

Field Details

effects

private final Map<ResourceLocation,DimensionSpecialEffects> effects

Constructor Details

RegisterDimensionSpecialEffectsEvent

@Internal
public RegisterDimensionSpecialEffectsEvent(Map<ResourceLocation,DimensionSpecialEffects> effects)

Method Details

register

public void register(ResourceLocation dimensionType,
 DimensionSpecialEffects effects)

Registers the effects for a given dimension type.