net.minecraftforge.client.event

Class RenderTooltipEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.client.event.RenderTooltipEvent

Direct Known Subclasses:

RenderTooltipEvent.Color, RenderTooltipEvent.Post, RenderTooltipEvent.Pre

public abstract class RenderTooltipEvent
extends 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 and Description
static class	RenderTooltipEvent.Color This event is fired when the colours for the tooltip background are determined.
protected static class	RenderTooltipEvent.Post Events inheriting from this class are fired at different stages during the tooltip rendering.
static class	RenderTooltipEvent.PostBackground This event is fired directly after the tooltip background is drawn, but before any text is drawn.
static class	RenderTooltipEvent.PostText This event is fired directly after the tooltip text is drawn, but before the GL state is reset.
static class	RenderTooltipEvent.Pre This event is fired before any tooltip calculations are done.

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
protected FontRenderer	fr
protected java.util.List<java.lang.String>	lines
protected ItemStack	stack
protected int	x
protected int	y

Constructor Summary

Constructors

Constructor and Description
RenderTooltipEvent(ItemStack stack, java.util.List<java.lang.String> lines, int x, int y, FontRenderer fr)

Method Summary

Modifier and Type	Method and Description
FontRenderer	getFontRenderer()
java.util.List<java.lang.String>	getLines() The lines to be drawn.
ItemStack	getStack()
int	getX()
int	getY()

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, 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 Detail

stack

@Nonnull
protected final ItemStack stack

lines

protected final java.util.List<java.lang.String> lines

x

protected int x

y

protected int y

fr

protected FontRenderer fr

Constructor Detail

RenderTooltipEvent

public RenderTooltipEvent(@Nonnull
                          ItemStack stack,
                          @Nonnull
                          java.util.List<java.lang.String> lines,
                          int x,
                          int y,
                          @Nonnull
                          FontRenderer fr)

Method Detail

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
public java.util.List<java.lang.String> getLines()

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.

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 FontRenderer getFontRenderer()

Returns:

The FontRenderer instance the current render is using.