Package net.neoforged.neoforge.client.event

Class RenderTooltipEvent.Pre

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RenderTooltipEvent

net.neoforged.neoforge.client.event.RenderTooltipEvent.Pre

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

RenderTooltipEvent

public static class RenderTooltipEvent.Pre
extends RenderTooltipEvent
implements net.neoforged.bus.api.ICancellableEvent

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

invalid reference

have a result

. If this event is cancelled, then the tooltip will not be rendered and the corresponding RenderTooltipEvent.Texture 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.neoforged.neoforge.client.event.RenderTooltipEvent

RenderTooltipEvent.GatherComponents, RenderTooltipEvent.Pre, RenderTooltipEvent.Texture

Field Summary

Fields

Modifier and Type	Field	Description
private final net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipPositioner	positioner
private final int	screenHeight
private final int	screenWidth

Fields inherited from class net.neoforged.neoforge.client.event.RenderTooltipEvent

components, font, graphics, itemStack, x, y

Constructor Summary

Constructors

Constructor	Description
Pre(net.minecraft.world.item.ItemStack stack, net.minecraft.client.gui.GuiGraphics graphics, int x, int y, int screenWidth, int screenHeight, net.minecraft.client.gui.Font font, List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> components, net.minecraft.client.gui.screens.inventory.tooltip.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.
net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipPositioner	getTooltipPositioner()
void	setFont(net.minecraft.client.gui.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.neoforged.neoforge.client.event.RenderTooltipEvent

getComponents, getFont, getGraphics, getItemStack, getX, getY

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

screenWidth

private final int screenWidth

screenHeight

private final int screenHeight

positioner

private final net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipPositioner positioner

Constructor Details

Pre

@Internal
public Pre(net.minecraft.world.item.ItemStack stack,
 net.minecraft.client.gui.GuiGraphics graphics,
 int x,
 int y,
 int screenWidth,
 int screenHeight,
 net.minecraft.client.gui.Font font,
 List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> components,
 net.minecraft.client.gui.screens.inventory.tooltip.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 net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipPositioner getTooltipPositioner()

setFont

public void setFont(net.minecraft.client.gui.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