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
Modifier and TypeClassDescriptionstatic class
TWidgetHudScreen.WidgetEntry<T extends TElement>
ATWidgetHudScreen
widget entry. -
Field Summary
Modifier and TypeFieldDescriptionprotected final net.minecraft.util.Identifier
protected @Nullable net.minecraft.client.gui.screen.Screen
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
ConstructorDescriptionTWidgetHudScreen
(net.minecraft.text.Text title, net.minecraft.util.Identifier hudScreenId) -
Method Summary
Modifier and TypeMethodDescriptionboolean
addEntry
(TWidgetHudScreen.WidgetEntry<?> entry) Adds aTWidgetHudScreen.WidgetEntry
to thisTWidgetHudScreen
.final void
Clears allTWidgetHudScreen.WidgetEntry
s from thisTWidgetHudScreen
.void
close()
boolean
containsEntry
(TWidgetHudScreen.WidgetEntry<?> entry) final int
Returns the number ofTWidgetHudScreen.WidgetEntry
s added to thisTWidgetHudScreen
.final net.minecraft.util.Identifier
Returns theIdentifier
for thisTWidgetHudScreen
that is used in theTClientRegistries.HUD_SCREEN
registry.final net.minecraft.client.gui.screen.Screen
Returns the "parent"Screen
that should be opened when the current one closes.protected void
init()
protected final boolean
initEntry
(TWidgetHudScreen.WidgetEntry<?> entry) Initializes aTWidgetHudScreen.WidgetEntry
that belongs to thisTWidgetHudScreen
.protected void
onClosed()
protected void
onOpened()
void
refresh()
final void
refreshEntry
(TWidgetHudScreen.WidgetEntry<?> entry) Refreshes aTWidgetHudScreen.WidgetEntry
's GUI by removing it and then re-creating it by usingTWidgetHudScreen.WidgetEntry.createWidget()
.boolean
removeEntry
(TWidgetHudScreen.WidgetEntry<?> entry) Removes aTWidgetHudScreen.WidgetEntry
from thisTWidgetHudScreen
.void
renderBackground
(TDrawContext pencil) Renders thisTScreen
's background.void
setParentScreen
(net.minecraft.client.gui.screen.Screen parent) Sets theparent
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 interfaceIParentScreenProvider
-
refresh
public void refresh() -
init
protected void init()Description copied from class:TScreen
-
initEntry
Initializes aTWidgetHudScreen.WidgetEntry
that belongs to thisTWidgetHudScreen
.- Parameters:
entry
- TheTWidgetHudScreen.WidgetEntry
fromentries
to initialize.
-
refreshEntry
Refreshes aTWidgetHudScreen.WidgetEntry
's GUI by removing it and then re-creating it by usingTWidgetHudScreen.WidgetEntry.createWidget()
. -
onOpened
protected void onOpened() -
onClosed
protected void onClosed() -
close
public void close() -
renderBackground
Description copied from class:TScreen
Renders thisTScreen
's background.Should be called before rendering children in
TScreen.render(TDrawContext)
.- Overrides:
renderBackground
in classTScreen
- Parameters:
pencil
- TheTDrawContext
.- See Also:
-
addEntry
Adds aTWidgetHudScreen.WidgetEntry
to thisTWidgetHudScreen
.- Returns:
true
if theTWidgetHudScreen.WidgetEntry
was added successfully.
-
containsEntry
-
removeEntry
Removes aTWidgetHudScreen.WidgetEntry
from thisTWidgetHudScreen
. -
clearEntries
public final void clearEntries()Clears allTWidgetHudScreen.WidgetEntry
s from thisTWidgetHudScreen
. -
entryCount
public final int entryCount()Returns the number ofTWidgetHudScreen.WidgetEntry
s added to thisTWidgetHudScreen
. -
getHudScreenID
public final net.minecraft.util.Identifier getHudScreenID()Returns theIdentifier
for thisTWidgetHudScreen
that is used in theTClientRegistries.HUD_SCREEN
registry. -
setParentScreen
public void setParentScreen(net.minecraft.client.gui.screen.Screen parent) Sets theparent
Screen
.- Parameters:
parent
- The new parentScreen
.- See Also:
-