Package net.neoforged.neoforge.client.event

Class CustomizeGuiOverlayEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.CustomizeGuiOverlayEvent

Direct Known Subclasses:

CustomizeGuiOverlayEvent.BossEventProgress, CustomizeGuiOverlayEvent.Chat, CustomizeGuiOverlayEvent.DebugText

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

Fired when an overlay is about to be rendered to the screen to allow the user to modify it.

See Also:

• CustomizeGuiOverlayEvent.BossEventProgress
• CustomizeGuiOverlayEvent.DebugText
• CustomizeGuiOverlayEvent.Chat

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomizeGuiOverlayEvent.BossEventProgress	Fired before a boss health bar is rendered to the screen.
static class	CustomizeGuiOverlayEvent.Chat	Fired before the chat messages overlay is rendered to the screen.
static class	CustomizeGuiOverlayEvent.DebugText	Fired before textual information is rendered to the debug 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 GuiGraphics	guiGraphics
private final float	partialTick
private final Window	window

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomizeGuiOverlayEvent(Window window, GuiGraphics guiGraphics, float partialTick)

Method Summary

Modifier and Type	Method	Description
GuiGraphics	getGuiGraphics()
float	getPartialTick()
Window	getWindow()

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

window

private final Window window

guiGraphics

private final GuiGraphics guiGraphics

partialTick

private final float partialTick

Constructor Details

CustomizeGuiOverlayEvent

@Internal
protected CustomizeGuiOverlayEvent(Window window,
 GuiGraphics guiGraphics,
 float partialTick)

Method Details

getWindow

public Window getWindow()

getGuiGraphics

public GuiGraphics getGuiGraphics()

getPartialTick

public float getPartialTick()