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.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.GatherComponents
• RenderTooltipEvent.Color

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.
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 final List<ClientTooltipComponent>	components
protected Font	font
protected final ItemStack	itemStack
protected final PoseStack	poseStack
protected int	x
protected int	y

Constructor Summary

Constructors

Constructor	Description
RenderTooltipEvent(ItemStack itemStack, PoseStack poseStack, int x, int y, Font font, List<ClientTooltipComponent> components)

Method Summary

Modifier and Type	Method	Description
List<ClientTooltipComponent>	getComponents()	The components to be drawn.
Font	getFont()
ItemStack	getItemStack()
PoseStack	getPoseStack()
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

itemStack

@Nonnull
protected final ItemStack itemStack

poseStack

protected final PoseStack poseStack

x

protected int x

y

protected int y

font

protected Font font

components

protected final List<ClientTooltipComponent> components

Constructor Details

RenderTooltipEvent

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

Method Details

getItemStack

@Nonnull
public ItemStack getItemStack()

Returns:

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

getPoseStack

public PoseStack getPoseStack()

Returns:

The PoseStack rendering context.

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.

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.

getFont

@Nonnull
public Font getFont()

Returns:

The Font instance the current render is using.