Class TTooltip

java.lang.Object

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

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

com.thecsdev.commonmc.api.client.gui.tooltip.TTooltip

All Implemented Interfaces:

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

@Environment(CLIENT)
@Virtual
public class TTooltip
extends TElement

A TElement whose sole purpose is meant to serve as being as tooltip element for other TElements.

Field Summary

Fields inherited from class TElement

eInitialized

Constructor Summary

Constructors

Constructor	Description
TTooltip()

Method Summary

Modifier and Type	Method	Description
static final TTooltip	of(@NotNull CustomStat stat)	A tooltip that shows the value of a given "custom stat" (also known as "general stat") in the statistics GUI.
static final TTooltip	of(@NotNull SubjectStats<?> stats)	A tooltip that shows the player statistics for a given SubjectStats.
static final TTooltip	of(@NotNull SubjectStats<?> stats, boolean showItemDescription)	A tooltip that shows the player statistics for a given SubjectStats.
static final TTooltip	of(@NotNull net.minecraft.network.chat.Component text)	Creates and returns a new simple textual tooltip element.
void	renderCallback(@NotNull TGuiGraphics pencil)	Callback method that is invoked when this Node is being rendered.

Methods inherited from class TElement

addRel, boundsProperty, clearAndInit, clipsDescendantsProperty, contextMenuProperty, dragEndCallback, dragStartCallback, findElementAt, focusableProperty, focusGainedCallback, focusLostCallback, forEachVisible, getBaseType, getBounds, getClient, getContentBounds, getCursor, getSelf, getTooltip, hoverableProperty, hoverGainedCallback, hoverLostCallback, initCallback, inputCallback, invalidateTooltipCache, isFocusable, isFocused, isHoverable, isHovered, isHoveredOrFocused, isVisible, move, moveChildren, moveTo, postRenderCallback, 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

TTooltip

public TTooltip()

Method Details

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 TElement

Parameters:

pencil - The rendering context.

of

public static final TTooltip of(@NotNull
 @NotNull net.minecraft.network.chat.Component text)
                         throws NullPointerException

Creates and returns a new simple textual tooltip element.

Parameters:

text - The tooltip text.

Throws:

NullPointerException - If the argument is null.

of

public static final TTooltip of(@NotNull
 @NotNull CustomStat stat)
                         throws NullPointerException

A tooltip that shows the value of a given "custom stat" (also known as "general stat") in the statistics GUI.

Parameters:

stat - The custom/general stat.

Throws:

NullPointerException - If the argument is null.

of

public static final TTooltip of(@NotNull
 @NotNull SubjectStats<?> stats)
                         throws NullPointerException

A tooltip that shows the player statistics for a given SubjectStats.

Parameters:

stats - The SubjectStats whose statistics are to be shown.

Throws:

NullPointerException - If the argument is null.

of

public static final TTooltip of(@NotNull
 @NotNull SubjectStats<?> stats,
 boolean showItemDescription)
                         throws NullPointerException

A tooltip that shows the player statistics for a given SubjectStats.

Parameters:

stats - The SubjectStats whose statistics are to be shown.

showItemDescription - Whether to include texts from Item Descriptions where possible.

Throws:

NullPointerException - If the argument is null.