Package net.neoforged.neoforge.client.event

Class ScreenEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.ScreenEvent

Direct Known Subclasses:

ScreenEvent.BackgroundRendered, ScreenEvent.CharacterTyped, ScreenEvent.Closing, ScreenEvent.Init, ScreenEvent.KeyInput, ScreenEvent.MouseInput, ScreenEvent.Opening, ScreenEvent.Render, ScreenEvent.RenderInventoryMobEffects

public abstract class ScreenEvent
extends net.neoforged.bus.api.Event

Fired on different events/actions when a Screen is active and visible. See the various subclasses for listening to different events.

These events are fired on the main Forge event bus, only on the logical client.

See Also:

• ScreenEvent.Init
• ScreenEvent.Render
• ScreenEvent.BackgroundRendered
• ScreenEvent.MouseInput
• ScreenEvent.KeyInput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScreenEvent.BackgroundRendered	Fired directly after the background of the screen is drawn.
static class	ScreenEvent.CharacterTyped	Fired when a keyboard key corresponding to a character is typed.
static class	ScreenEvent.Closing	Fired before a Screen is closed.
static class	ScreenEvent.Init	Fired when a screen is being initialized.
private static class	ScreenEvent.KeyInput	Fired whenever a keyboard key is pressed or released.
static class	ScreenEvent.KeyPressed	Fired when a keyboard key is pressed.
static class	ScreenEvent.KeyReleased	Fired when a keyboard key is released.
static class	ScreenEvent.MouseButtonPressed	Fired when a mouse button is pressed.
static class	ScreenEvent.MouseButtonReleased	Fired when a mouse button is released.
static class	ScreenEvent.MouseDragged	Fired when the mouse was dragged while a button is being held down.
private static class	ScreenEvent.MouseInput	Fired whenever an action is performed by the mouse.
static class	ScreenEvent.MouseScrolled	Fired when the mouse was dragged while a button is being held down.
static class	ScreenEvent.Opening	Fired before any Screen is opened, to allow changing it or preventing it from being opened.
static class	ScreenEvent.Render	Fired when a screen is being drawn.
static class	ScreenEvent.RenderInventoryMobEffects	Fired ahead of rendering any active mob effects in the inventory screen.

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 Screen	screen

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScreenEvent(Screen screen)

Method Summary

Modifier and Type	Method	Description
Screen	getScreen()	Returns the screen that caused this event.

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

screen

private final Screen screen

Constructor Details

ScreenEvent

@Internal
protected ScreenEvent(Screen screen)

Method Details

getScreen

public Screen getScreen()

Returns the screen that caused this event.

Returns:

the screen that caused this event