Package net.neoforged.neoforge.client.event

Class RegisterDimensionTransitionScreenEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RegisterDimensionTransitionScreenEvent

All Implemented Interfaces:

net.neoforged.fml.event.IModBusEvent

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

Event for registering screen effects when transitioning across dimensions. Note that there is a priority order when it comes to what screens are displayed:
- Using registerConditionalEffect has priority over the usual transition effects, and will only fire when travelling to the specified dimension coming from a certain dimension.
- If a dimension has a screen that displays when entering it, that will have priority over a dimension that has one when you leave it.

This event is not cancellable, and does not

invalid reference

have a result

.

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<com.mojang.datafixers.util.Pair<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory>	conditionalDimensionEffects
private final Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory>	fromEffects
private final Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory>	toEffects

Constructor Summary

Constructors

Constructor

Description

RegisterDimensionTransitionScreenEvent(Map<com.mojang.datafixers.util.Pair<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> conditionalDimensionEffects, Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> toEffects, Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> fromEffects)

Method Summary

Modifier and Type	Method	Description
boolean	registerConditionalEffect(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> toDimension, net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> fromDimension, DimensionTransitionScreenManager.ReceivingLevelScreenFactory screen)	Registers a dimension transition when traveling to a dimension from a certain dimension.
boolean	registerIncomingEffect(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, DimensionTransitionScreenManager.ReceivingLevelScreenFactory screen)	Registers a dimension transition when traveling to a dimension.
boolean	registerOutgoingEffect(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension, DimensionTransitionScreenManager.ReceivingLevelScreenFactory screen)	Registers a dimension transition when traveling from a dimension.

Methods inherited from class java.lang.Object

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

Field Details

conditionalDimensionEffects

private final Map<com.mojang.datafixers.util.Pair<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> conditionalDimensionEffects

toEffects

private final Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> toEffects

fromEffects

private final Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> fromEffects

Constructor Details

RegisterDimensionTransitionScreenEvent

@Internal
public RegisterDimensionTransitionScreenEvent(Map<com.mojang.datafixers.util.Pair<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> conditionalDimensionEffects,
 Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> toEffects,
 Map<net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level>,DimensionTransitionScreenManager.ReceivingLevelScreenFactory> fromEffects)

Method Details

registerIncomingEffect

public boolean registerIncomingEffect(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
 DimensionTransitionScreenManager.ReceivingLevelScreenFactory screen)

Registers a dimension transition when traveling to a dimension.

Returns:

true if the screen was registered, false otherwise.

registerOutgoingEffect

public boolean registerOutgoingEffect(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> dimension,
 DimensionTransitionScreenManager.ReceivingLevelScreenFactory screen)

Registers a dimension transition when traveling from a dimension.

Returns:

true if the screen was registered, false otherwise.

registerConditionalEffect

public boolean registerConditionalEffect(net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> toDimension,
 net.minecraft.resources.ResourceKey<net.minecraft.world.level.Level> fromDimension,
 DimensionTransitionScreenManager.ReceivingLevelScreenFactory screen)

Registers a dimension transition when traveling to a dimension from a certain dimension. This registration method takes priority over the normal to and from dimension checks.

Returns:

true if the screen was registered, false otherwise.