Package net.neoforged.neoforge.client.event

Class ScreenEvent.Opening

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ScreenEvent

net.neoforged.neoforge.client.event.ScreenEvent.Opening

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

ScreenEvent

public static class ScreenEvent.Opening
extends ScreenEvent
implements net.neoforged.bus.api.ICancellableEvent

Fired before any Screen is opened, to allow changing it or preventing it from being opened. All screen layers on the screen are closed before this event is fired.

This event is cancellable, and does not

invalid reference

have a result

. If this event is cancelled, then the Screen shall be prevented from opening and any previous screen will remain open. However, cancelling this event will not prevent the closing of screen layers which happened before this event fired.

This event is fired on the main Forge event bus, only on the logical client.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.client.event.ScreenEvent

ScreenEvent.CharacterTyped, ScreenEvent.Closing, ScreenEvent.Init, ScreenEvent.KeyPressed, ScreenEvent.KeyReleased, ScreenEvent.MouseButtonPressed, ScreenEvent.MouseButtonReleased, ScreenEvent.MouseDragged, ScreenEvent.MouseScrolled, ScreenEvent.Opening, ScreenEvent.Render, ScreenEvent.RenderInventoryMobEffects

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable net.minecraft.client.gui.screens.Screen	currentScreen
private net.minecraft.client.gui.screens.Screen	newScreen

Constructor Summary

Constructors

Constructor	Description
Opening(@Nullable net.minecraft.client.gui.screens.Screen currentScreen, net.minecraft.client.gui.screens.Screen screen)

Method Summary

Modifier and Type	Method	Description
@Nullable net.minecraft.client.gui.screens.Screen	getCurrentScreen()	Gets the currently open screen at the time of the event being fired.
@Nullable net.minecraft.client.gui.screens.Screen	getNewScreen()
void	setNewScreen(net.minecraft.client.gui.screens.Screen newScreen)	Sets the new screen to be opened if the event is not cancelled.

Methods inherited from class net.neoforged.neoforge.client.event.ScreenEvent

getScreen

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

currentScreen

@Nullable
private final @Nullable net.minecraft.client.gui.screens.Screen currentScreen

newScreen

private net.minecraft.client.gui.screens.Screen newScreen

Constructor Details

Opening

@Internal
public Opening(@Nullable
 @Nullable net.minecraft.client.gui.screens.Screen currentScreen,
 net.minecraft.client.gui.screens.Screen screen)

Method Details

getCurrentScreen

@Nullable
public @Nullable net.minecraft.client.gui.screens.Screen getCurrentScreen()

Gets the currently open screen at the time of the event being fired.

May be null if no screen was open.

getNewScreen

@Nullable
public @Nullable net.minecraft.client.gui.screens.Screen getNewScreen()

Returns:

The screen that will be opened if the event is not cancelled. May be null.

setNewScreen

public void setNewScreen(net.minecraft.client.gui.screens.Screen newScreen)

Sets the new screen to be opened if the event is not cancelled. May be null.