Package net.minecraftforge.client.event

Class RenderTooltipEvent.Pre

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.RenderTooltipEvent

net.minecraftforge.client.event.RenderTooltipEvent.Pre

Enclosing class:

RenderTooltipEvent

public static class RenderTooltipEvent.Pre
extends RenderTooltipEvent

Fired before the tooltip is rendered. This can be used to modify the positioning and font of the tooltip.

This event is cancellable, and does not have a result. If this event is cancelled, then the tooltip will not be rendered and the corresponding RenderTooltipEvent.Color will not be fired.

This event is fired on the main Forge event bus, only on the logical client.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.client.event.RenderTooltipEvent

RenderTooltipEvent.Color, RenderTooltipEvent.GatherComponents, RenderTooltipEvent.Pre

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
private final ClientTooltipPositioner	positioner
private final int	screenHeight
private final int	screenWidth

Fields inherited from class net.minecraftforge.client.event.RenderTooltipEvent

components, font, graphics, itemStack, x, y

Constructor Summary

Constructors

Constructor	Description
Pre(@NotNull ItemStack stack, GuiGraphics graphics, int x, int y, int screenWidth, int screenHeight, @NotNull Font font, @NotNull List<ClientTooltipComponent> components, @NotNull ClientTooltipPositioner positioner)

Method Summary

Modifier and Type	Method	Description
int	getScreenHeight()	Returns the height of the screen.
int	getScreenWidth()	Returns the width of the screen.
ClientTooltipPositioner	getTooltipPositioner()
void	setFont(@NotNull Font fr)	Sets the font to be used to render text.
void	setX(int x)	Sets the X origin of the tooltip.
void	setY(int y)	Sets the Y origin of the tooltip.

Methods inherited from class net.minecraftforge.client.event.RenderTooltipEvent

getComponents, getFont, getGraphics, getItemStack, getX, getY

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

screenWidth

private final int screenWidth

screenHeight

private final int screenHeight

positioner

private final ClientTooltipPositioner positioner

Constructor Details

Pre

@Internal
public Pre(@NotNull
 @NotNull ItemStack stack,
 GuiGraphics graphics,
 int x,
 int y,
 int screenWidth,
 int screenHeight,
 @NotNull
 @NotNull Font font,
 @NotNull
 @NotNull List<ClientTooltipComponent> components,
 @NotNull
 @NotNull ClientTooltipPositioner positioner)

Method Details

getScreenWidth

public int getScreenWidth()

Returns the width of the screen.. The lines of text within the tooltip are wrapped to be within the screen width, and the tooltip box itself is moved to be within the screen width.

Returns:

the width of the screen

getScreenHeight

public int getScreenHeight()

Returns the height of the screen. The tooltip box is moved to be within the screen height.

Returns:

the height of the screen

getTooltipPositioner

public ClientTooltipPositioner getTooltipPositioner()

setFont

public void setFont(@NotNull
 @NotNull Font fr)

Sets the font to be used to render text.

Parameters:

fr - the new font

setX

public void setX(int x)

Sets the X origin of the tooltip.

Parameters:

x - the new X origin

setY

public void setY(int y)

Sets the Y origin of the tooltip.

Parameters:

y - the new Y origin