Class TCustomStatWidget

java.lang.Object

com.thecsdev.common.scene.Node<TElement>

com.thecsdev.commonmc.api.client.gui.TElement

com.thecsdev.commonmc.api.client.gui.widget.TClickableWidget

com.thecsdev.commonmc.api.client.gui.widget.TButtonWidget

com.thecsdev.commonmc.api.client.gui.widget.stats.TTextualStatWidget

com.thecsdev.commonmc.api.client.gui.widget.stats.TCustomStatWidget

All Implemented Interfaces:

INode<TElement>, INodeBounded<TElement,Bounds2i>, INodeRenderable<TElement, TGuiGraphics>, Iterable<TElement>, Collection<TElement>

@Environment(CLIENT)
public final class TCustomStatWidget
extends TTextualStatWidget

Textual stat widget that shows the name and value of a "custom stat", also known as "general stat" in the game's statistics GUI.

Nested Class Summary

Nested classes/interfaces inherited from class TButtonWidget

TButtonWidget.Flat, TButtonWidget.Paintable, TButtonWidget.Transparent

Field Summary

Fields inherited from class TButtonWidget

LBL_PAD_X, LBL_PAD_Y

Fields inherited from class TClickableWidget

eClicked, ONCLICK_SOUND

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TCustomStatWidget()
TCustomStatWidget(@Nullable CustomStat stat)
TCustomStatWidget(@NotNull net.minecraft.resources.Identifier subject, @NotNull IStatsProvider provider)

Method Summary

Modifier and Type	Method	Description
final IntegerProperty	backgroundColorProperty()	The IntegerProperty for this stat widget's background color.
final IntegerProperty	focusOutlineColorProperty()	The IntegerProperty for this stat widget's focus outline color.
final ObjectProperty<StatFormatterOverride>	formatterOverrideProperty()	The ObjectProperty holding the StatFormatterOverride used to format the stat's value for display.
protected void	initCallback()	Callback method that is invoked when this TElement is initializing.
final IntegerProperty	outlineColorProperty()	The IntegerProperty for this stat widget's outline color.
void	postRenderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked after this Node and all of their children have been rendered.
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.
final ObjectProperty<CustomStat>	statProperty()	The ObjectProperty holding the CustomStat whose statistics are to be shown.

Methods inherited from class TTextualStatWidget

getKeyLabel, getValueLabel

Methods inherited from class TButtonWidget

getLabel

Methods inherited from class TClickableWidget

click, clickCallback, dragEndCallback, dragStartCallback, enabledProperty, focusLostCallback, getCursor, hoverGainedCallback, inputCallback, isFocusable, pressedProperty

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, findElementAt, focusableProperty, focusGainedCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getSelf, getTooltip, hoverableProperty, hoverLostCallback, invalidateTooltipCache, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, removeRel, screenProperty, setBounds, setBounds, setBounds, showContextMenu, tickCallback, tooltipProperty, toString, visibleProperty

Methods inherited from class Node

add, addAll, childAddedCallback, childRemovedCallback, clear, contains, containsAll, equals, findChild, findParent, findSibling, forEach, get, getFirst, getLast, getParent, hashCode, indexOf, isEmpty, iterator, parentProperty, remove, remove, remove, removeAll, retainAll, rootProperty, size, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Iterable

forEach

Constructor Details

TCustomStatWidget

public TCustomStatWidget()

TCustomStatWidget

public TCustomStatWidget(@NotNull
 @NotNull net.minecraft.resources.Identifier subject,
 @NotNull
 @NotNull IStatsProvider provider)

TCustomStatWidget

public TCustomStatWidget(@Nullable
 @Nullable CustomStat stat)

Method Details

initCallback

protected void initCallback()

Description copied from class: TElement

Callback method that is invoked when this TElement is initializing. You may override this method to create and add child TElements.

Overrides:

initCallback in class TTextualStatWidget

See Also:

• TElement.clearAndInit()

statProperty

public final ObjectProperty<CustomStat> statProperty()

The ObjectProperty holding the CustomStat whose statistics are to be shown.

formatterOverrideProperty

public final ObjectProperty<StatFormatterOverride> formatterOverrideProperty()

The ObjectProperty holding the StatFormatterOverride used to format the stat's value for display. If the value is null, the default formatter will be used.

backgroundColorProperty

public final IntegerProperty backgroundColorProperty()

The IntegerProperty for this stat widget's background color. This color is drawn in the background of this element.

outlineColorProperty

public final IntegerProperty outlineColorProperty()

The IntegerProperty for this stat widget's outline color. This color is drawn as the outline.

focusOutlineColorProperty

public final IntegerProperty focusOutlineColorProperty()

The IntegerProperty for this stat widget's focus outline color. This color is drawn as the outline when this element is focused.

renderCallback

@Virtual
public void renderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked when this Node is being rendered.

Specified by:

renderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

renderCallback in class TButtonWidget

Parameters:

pencil - The rendering context.

postRenderCallback

@Virtual
public void postRenderCallback(@NotNull
 @NotNull TGuiGraphics pencil)

Description copied from interface: INodeRenderable

Callback method that is invoked after this Node and all of their children have been rendered.

Specified by:

postRenderCallback in interface INodeRenderable<TElement, TGuiGraphics>

Overrides:

postRenderCallback in class TClickableWidget

Parameters:

pencil - The rendering context.