Package io.github.thecsdev.tcdcommons.api.client.gui.screen

Class TWidgetHudScreen

java.lang.Object

io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreen

io.github.thecsdev.tcdcommons.api.client.gui.screen.TWidgetHudScreen

All Implemented Interfaces:

TParentElement, IParentScreenProvider, IEnableStateProvider

Direct Known Subclasses:

TestTWidgetHudScreen

@Experimental
public abstract class TWidgetHudScreen
extends TScreen
implements IParentScreenProvider

A TScreen whose primary purpose is appending GUI widgets to the InGameHud via TClientRegistries.HUD_SCREEN.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TWidgetHudScreen.WidgetEntry<T extends TElement>	A TWidgetHudScreen widget entry.

Field Summary

Fields

Modifier and Type	Field	Description
protected final net.minecraft.util.Identifier	hudScreenId
protected @Nullable net.minecraft.client.gui.screen.Screen	parent

Fields inherited from class io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreen

children, client, title

Fields inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

MAX_CHILD_NESTING_DEPTH

Constructor Summary

Constructors

Constructor	Description
TWidgetHudScreen(net.minecraft.text.Text title, net.minecraft.util.Identifier hudScreenId)

Method Summary

Modifier and Type	Method	Description
boolean	addEntry(TWidgetHudScreen.WidgetEntry<?> entry)	Adds a TWidgetHudScreen.WidgetEntry to this TWidgetHudScreen.
final void	clearEntries()	Clears all TWidgetHudScreen.WidgetEntrys from this TWidgetHudScreen.
void	close()
boolean	containsEntry(TWidgetHudScreen.WidgetEntry<?> entry)	Returns true if this TWidgetHudScreen contains a given TWidgetHudScreen.WidgetEntry.
final int	entryCount()	Returns the number of TWidgetHudScreen.WidgetEntrys added to this TWidgetHudScreen.
final net.minecraft.util.Identifier	getHudScreenID()	Returns the Identifier for this TWidgetHudScreen that is used in the TClientRegistries.HUD_SCREEN registry.
final net.minecraft.client.gui.screen.Screen	getParentScreen()	Returns the "parent" Screen that should be opened when the current one closes.
protected void	init()	Initializes this TScreen. Add TElements to this TScreen here.
protected final boolean	initEntry(TWidgetHudScreen.WidgetEntry<?> entry)	Initializes a TWidgetHudScreen.WidgetEntry that belongs to this TWidgetHudScreen.
protected void	onClosed()
protected void	onOpened()
void	refresh()	Refreshes this TWidgetHudScreen by calling TParentElement.clearChildren() and then calling init().
final void	refreshEntry(TWidgetHudScreen.WidgetEntry<?> entry)	Refreshes a TWidgetHudScreen.WidgetEntry's GUI by removing it and then re-creating it by using TWidgetHudScreen.WidgetEntry.createWidget().
boolean	removeEntry(TWidgetHudScreen.WidgetEntry<?> entry)	Removes a TWidgetHudScreen.WidgetEntry from this TWidgetHudScreen.
void	renderBackground(TDrawContext pencil)	Renders this TScreen's background.
void	setParentScreen(net.minecraft.client.gui.screen.Screen parent)	Sets the parent Screen.

Methods inherited from class io.github.thecsdev.tcdcommons.api.client.gui.screen.TScreen

__postTabNavigation, createScreenWrapper, filesDragged, getAsScreen, getChildren, getClient, getDraggingElement, getEnabled, getFocusedElement, getHeight, getHoveredElement, getItemRenderer, getMousePosition, getParent, getTextRenderer, getTitle, getWidth, getX, getY, getZIndex, hasKeyDown, hasWndDown, input, inputTabNavigation, isEnabled, isOpen, render, renderChildren, renderTooltip, setFocusedElement, setFocusedElement, shouldCloseOnEsc, shouldPause, shouldRenderInGameHud, tick

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thecsdev.tcdcommons.api.client.gui.TParentElement

addChild, addChild, clearChildren, findChild, findLastChild, findParent, findParentTElement, forEachChild, getEndX, getEndY, input, removeChild, removeChild

Field Details

hudScreenId

protected final net.minecraft.util.Identifier hudScreenId

parent

@Nullable
protected @Nullable net.minecraft.client.gui.screen.Screen parent

Constructor Details

TWidgetHudScreen

public TWidgetHudScreen(net.minecraft.text.Text title,
 net.minecraft.util.Identifier hudScreenId)
                 throws NullPointerException

Throws:

NullPointerException

Method Details

getParentScreen

public final net.minecraft.client.gui.screen.Screen getParentScreen()

Description copied from interface: IParentScreenProvider

Returns the "parent" Screen that should be opened when the current one closes.

Specified by:

getParentScreen in interface IParentScreenProvider

refresh

public void refresh()

Refreshes this TWidgetHudScreen by calling TParentElement.clearChildren() and then calling init().

init

protected void init()

Description copied from class: TScreen

Initializes this TScreen.
Add TElements to this TScreen here.

Specified by:

init in class TScreen

initEntry

protected final boolean initEntry(TWidgetHudScreen.WidgetEntry<?> entry)

Initializes a TWidgetHudScreen.WidgetEntry that belongs to this TWidgetHudScreen.

Parameters:

entry - The TWidgetHudScreen.WidgetEntry from entries to initialize.

refreshEntry

public final void refreshEntry(TWidgetHudScreen.WidgetEntry<?> entry)

Refreshes a TWidgetHudScreen.WidgetEntry's GUI by removing it and then re-creating it by using TWidgetHudScreen.WidgetEntry.createWidget().

onOpened

protected void onOpened()

Overrides:

onOpened in class TScreen

onClosed

protected void onClosed()

Overrides:

onClosed in class TScreen

close

public void close()

Overrides:

close in class TScreen

renderBackground

public void renderBackground(TDrawContext pencil)

Description copied from class: TScreen

Renders this TScreen's background.

Should be called before rendering children in TScreen.render(TDrawContext).

Overrides:

renderBackground in class TScreen

Parameters:

pencil - The TDrawContext.

See Also:

• TScreen.render(TDrawContext)
• TScreen.renderChildren(TDrawContext)

addEntry

public boolean addEntry(TWidgetHudScreen.WidgetEntry<?> entry)

Adds a TWidgetHudScreen.WidgetEntry to this TWidgetHudScreen.

Returns:

true if the TWidgetHudScreen.WidgetEntry was added successfully.

containsEntry

public boolean containsEntry(TWidgetHudScreen.WidgetEntry<?> entry)

Returns true if this TWidgetHudScreen contains a given TWidgetHudScreen.WidgetEntry.

removeEntry

public boolean removeEntry(TWidgetHudScreen.WidgetEntry<?> entry)

Removes a TWidgetHudScreen.WidgetEntry from this TWidgetHudScreen.

clearEntries

public final void clearEntries()

Clears all TWidgetHudScreen.WidgetEntrys from this TWidgetHudScreen.

entryCount

public final int entryCount()

Returns the number of TWidgetHudScreen.WidgetEntrys added to this TWidgetHudScreen.

getHudScreenID

public final net.minecraft.util.Identifier getHudScreenID()

Returns the Identifier for this TWidgetHudScreen that is used in the TClientRegistries.HUD_SCREEN registry.

setParentScreen

public void setParentScreen(net.minecraft.client.gui.screen.Screen parent)

Sets the parent Screen.

Parameters:

parent - The new parent Screen.

See Also:

• getParentScreen()