Package net.neoforged.neoforge.client.event

Class RenderGuiOverlayEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RenderGuiOverlayEvent

Direct Known Subclasses:

RenderGuiOverlayEvent.Post, RenderGuiOverlayEvent.Pre

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

Fired when an overlay is rendered to the screen. See the two subclasses for listening to the two possible phases.

An overlay that is not normally active cannot be forced to render. In such cases, this event will not fire.

See Also:

• RenderGuiOverlayEvent.Pre
• RenderGuiOverlayEvent.Post

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderGuiOverlayEvent.Post	Fired after an GUI overlay is rendered to the screen, if the corresponding RenderGuiOverlayEvent.Pre is not cancelled.
static class	RenderGuiOverlayEvent.Pre	Fired before a GUI overlay is rendered to the 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 NamedGuiOverlay	overlay
private final float	partialTick
private final Window	window

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RenderGuiOverlayEvent(Window window, GuiGraphics guiGraphics, float partialTick, NamedGuiOverlay overlay)

Method Summary

Modifier and Type	Method	Description
GuiGraphics	getGuiGraphics()
NamedGuiOverlay	getOverlay()
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

overlay

private final NamedGuiOverlay overlay

Constructor Details

RenderGuiOverlayEvent

@Internal
protected RenderGuiOverlayEvent(Window window,
 GuiGraphics guiGraphics,
 float partialTick,
 NamedGuiOverlay overlay)

Method Details

getWindow

public Window getWindow()

getGuiGraphics

public GuiGraphics getGuiGraphics()

getPartialTick

public float getPartialTick()

getOverlay

public NamedGuiOverlay getOverlay()