Package net.minecraftforge.client.event

Class RenderTooltipEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.RenderTooltipEvent

Direct Known Subclasses:

RenderTooltipEvent.Color, RenderTooltipEvent.Post, RenderTooltipEvent.Pre

public abstract class RenderTooltipEvent
extends net.minecraftforge.eventbus.api.Event

A set of events which are fired at various points during tooltip rendering.

Can be used to change the rendering parameters, draw something extra, etc.

Do not use this event directly, use one of the subclasses:

• RenderTooltipEvent.Pre
• RenderTooltipEvent.PostBackground
• RenderTooltipEvent.PostText

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderTooltipEvent.Color	This event is fired when the colours for the tooltip background are determined.
static class	RenderTooltipEvent.GatherComponents	Fires when a tooltip gathers the TooltipComponents to render.
protected static class	RenderTooltipEvent.Post	Deprecated, for removal: This API element is subject to removal in a future version.
static class	RenderTooltipEvent.PostBackground	Deprecated, for removal: This API element is subject to removal in a future version.
static class	RenderTooltipEvent.PostText	Deprecated, for removal: This API element is subject to removal in a future version.
static class	RenderTooltipEvent.Pre	This event is fired before any tooltip calculations are done.

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
protected List<ClientTooltipComponent>	components
protected Font	fr
protected List<? extends FormattedText>	lines	Deprecated, for removal: This API element is subject to removal in a future version.
protected PoseStack	matrixStack
protected ItemStack	stack
protected int	x
protected int	y

Constructor Summary

Constructors

Constructor	Description
RenderTooltipEvent(ItemStack stack, PoseStack poseStack, int x, int y, Font font, List<ClientTooltipComponent> components)
RenderTooltipEvent(ItemStack stack, List<? extends FormattedText> lines, PoseStack matrixStack, int x, int y, Font fr)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
List<ClientTooltipComponent>	getComponents()	The components to be drawn.
Font	getFontRenderer()
List<? extends FormattedText>	getLines()	Deprecated, for removal: This API element is subject to removal in a future version. use getComponents()
PoseStack	getMatrixStack()
ItemStack	getStack()
int	getX()
int	getY()

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

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

Methods inherited from class java.lang.Object

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

Field Details

stack

@Nonnull
protected final ItemStack stack

lines

@Deprecated(since="1.18",
            forRemoval=true)
protected final List<? extends FormattedText> lines

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

matrixStack

protected final PoseStack matrixStack

x

protected int x

y

protected int y

fr

protected Font fr

components

protected final List<ClientTooltipComponent> components

Constructor Details

RenderTooltipEvent

@Deprecated(since="1.18",
            forRemoval=true)
public RenderTooltipEvent(@Nonnull
 ItemStack stack,
 @Nonnull
 List<? extends FormattedText> lines,
 PoseStack matrixStack,
 int x,
 int y,
 @Nonnull
 Font fr)

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

RenderTooltipEvent

public RenderTooltipEvent(@Nonnull
 ItemStack stack,
 PoseStack poseStack,
 int x,
 int y,
 @Nonnull
 Font font,
 @Nonnull
 List<ClientTooltipComponent> components)

Method Details

getStack

@Nonnull
public ItemStack getStack()

Returns:

The stack which the tooltip is being rendered for. As tooltips can be drawn without itemstacks, this stack may be empty.

getLines

@Nonnull
@Deprecated(since="1.18",
            forRemoval=true)
public List<? extends FormattedText> getLines()

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

use getComponents()

The lines to be drawn. May change between RenderTooltipEvent.Pre and RenderTooltipEvent.Post.

Returns:

An unmodifiable list of strings. Use ItemTooltipEvent to modify tooltip text.

getComponents

@Nonnull
public List<ClientTooltipComponent> getComponents()

The components to be drawn. To modify this list use RenderTooltipEvent.GatherComponents.

Returns:

an unmodifiable list of tooltip components to be drawn.

getMatrixStack

public PoseStack getMatrixStack()

Returns:

The MatrixStack of the current rendering context

getX

public int getX()

Returns:

The X position of the tooltip box. By default, the mouse X position.

getY

public int getY()

Returns:

The Y position of the tooltip box. By default, the mouse Y position.

getFontRenderer

@Nonnull
public Font getFontRenderer()

Returns:

The Font instance the current render is using.