Package net.minecraftforge.client.event

Class CustomizeGuiOverlayEvent.DebugText

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.CustomizeGuiOverlayEvent

net.minecraftforge.client.event.CustomizeGuiOverlayEvent.DebugText

Enclosing class:

CustomizeGuiOverlayEvent

public static class CustomizeGuiOverlayEvent.DebugText
extends CustomizeGuiOverlayEvent

Fired before textual information is rendered to the debug screen. This can be used to add or remove text information.

This event is not cancellable, and does not have a result.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CustomizeGuiOverlayEvent.DebugText.Side

Nested classes/interfaces inherited from class net.minecraftforge.client.event.CustomizeGuiOverlayEvent

CustomizeGuiOverlayEvent.BossEventProgress, CustomizeGuiOverlayEvent.Chat, CustomizeGuiOverlayEvent.DebugText

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final CustomizeGuiOverlayEvent.DebugText.Side	side
private final List<String>	text

Constructor Summary

Constructors

Constructor	Description
DebugText(Window window, GuiGraphics guiGraphics, float partialTick, List<String> text, CustomizeGuiOverlayEvent.DebugText.Side side)

Method Summary

Modifier and Type	Method	Description
List<String>	getLeft()	Deprecated, for removal: This API element is subject to removal in a future version.
List<String>	getRight()	Deprecated, for removal: This API element is subject to removal in a future version.
CustomizeGuiOverlayEvent.DebugText.Side	getSide()
List<String>	getText()

Methods inherited from class net.minecraftforge.client.event.CustomizeGuiOverlayEvent

getGuiGraphics, getPartialTick, getWindow

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.Object

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

Field Details

text

private final List<String> text

side

private final CustomizeGuiOverlayEvent.DebugText.Side side

Constructor Details

DebugText

@Internal
public DebugText(Window window,
 GuiGraphics guiGraphics,
 float partialTick,
 List<String> text,
 CustomizeGuiOverlayEvent.DebugText.Side side)

Method Details

getText

public List<String> getText()

Returns:

the modifiable list of text to render on the side

getLeft

@Deprecated(forRemoval=true,
            since="1.20.6")
public List<String> getLeft()

Deprecated, for removal: This API element is subject to removal in a future version.

getRight

@Deprecated(forRemoval=true,
            since="1.20.6")
public List<String> getRight()

Deprecated, for removal: This API element is subject to removal in a future version.

getSide

public CustomizeGuiOverlayEvent.DebugText.Side getSide()

Returns:

the side of the text getting rendered.