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

Fired during tooltip rendering. See the various subclasses for listening to specific events.

See Also:

• RenderTooltipEvent.GatherComponents
• RenderTooltipEvent.Pre
• RenderTooltipEvent.Color

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderTooltipEvent.Color	Fired when the colours for the tooltip background are determined.
static class	RenderTooltipEvent.GatherComponents	Fired when a tooltip gathers the TooltipComponents to be rendered, before any text wrapping or processing.
static class	RenderTooltipEvent.Pre	Fired before the tooltip is rendered.

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 GuiGraphics	graphics
protected final @NotNull ItemStack	itemStack
protected int	x
protected int	y

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RenderTooltipEvent(@NotNull ItemStack itemStack, GuiGraphics graphics, int x, int y, @NotNull Font font, @NotNull List<ClientTooltipComponent> components)

Method Summary

Modifier and Type	Method	Description
@NotNull List<ClientTooltipComponent>	getComponents()	Returns the unmodifiable list of tooltip components.
@NotNull Font	getFont()	Returns The font used to render the text.
GuiGraphics	getGraphics()	Returns the graphics helper for the gui.
@NotNull ItemStack	getItemStack()	Returns the item stack which the tooltip is being rendered for, or an empty item stack if there is no associated item stack.
int	getX()	Returns the X position of the tooltip box.
int	getY()	Returns the Y position of the tooltip box.

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

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

Methods inherited from class java.lang.Object

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

Field Details

itemStack

@NotNull
protected final @NotNull ItemStack itemStack

graphics

protected final GuiGraphics graphics

x

protected int x

y

protected int y

font

protected Font font

components

protected final List<ClientTooltipComponent> components

Constructor Details

RenderTooltipEvent

@Internal
protected RenderTooltipEvent(@NotNull
 @NotNull ItemStack itemStack,
 GuiGraphics graphics,
 int x,
 int y,
 @NotNull
 @NotNull Font font,
 @NotNull
 @NotNull List<ClientTooltipComponent> components)

Method Details

getItemStack

@NotNull
public @NotNull ItemStack getItemStack()

Returns the item stack which the tooltip is being rendered for, or an empty item stack if there is no associated item stack.

Returns:

the item stack which the tooltip is being rendered for, or an empty item stack if there is no associated item stack

getGraphics

public GuiGraphics getGraphics()

Returns the graphics helper for the gui.

Returns:

the graphics helper for the gui

getComponents

@NotNull
public @NotNull List<ClientTooltipComponent> getComponents()

Returns the unmodifiable list of tooltip components.

Use ItemTooltipEvent or RenderTooltipEvent.GatherComponents to modify tooltip contents or components.

Returns:

the unmodifiable list of tooltip components

getX

public int getX()

Returns the X position of the tooltip box. By default, this is the mouse X position.

Returns:

the X position of the tooltip box

getY

public int getY()

Returns the Y position of the tooltip box. By default, this is the mouse Y position.

Returns:

the Y position of the tooltip box

getFont

@NotNull
public @NotNull Font getFont()

Returns The font used to render the text.

Returns:

The font used to render the text