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

This event is fired before any tooltip calculations are done. It provides setters for all aspects of the tooltip, so the final render can be modified.

This event is Cancelable.

Nested Class Summary

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

RenderTooltipEvent.Color, RenderTooltipEvent.GatherComponents, RenderTooltipEvent.Post, RenderTooltipEvent.PostBackground, RenderTooltipEvent.PostText, 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 int	maxWidth
private int	screenHeight
private int	screenWidth

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

components, fr, lines, matrixStack, stack, x, y

Constructor Summary

Constructors

Constructor	Description
Pre(ItemStack stack, PoseStack matrixStack, int x, int y, int screenWidth, int screenHeight, Font font, List<ClientTooltipComponent> components)
Pre(ItemStack stack, List<? extends FormattedText> lines, PoseStack matrixStack, int x, int y, int screenWidth, int screenHeight, int maxWidth, Font fr)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
int	getMaxWidth()	Deprecated, for removal: This API element is subject to removal in a future version. use RenderTooltipEvent.GatherComponents
int	getScreenHeight()
int	getScreenWidth()
void	setFontRenderer(Font fr)	Sets the Font to be used to render text.
void	setMaxWidth(int maxWidth)	Deprecated, for removal: This API element is subject to removal in a future version. use RenderTooltipEvent.GatherComponents
void	setScreenHeight(int screenHeight)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setScreenWidth(int screenWidth)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setX(int x)	Set the X origin of the tooltip.
void	setY(int y)	Set the Y origin of the tooltip.

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

getComponents, getFontRenderer, getLines, getMatrixStack, getStack, getX, 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

screenWidth

private int screenWidth

screenHeight

private int screenHeight

maxWidth

private int maxWidth

Constructor Details

Pre

@Deprecated(since="1.18",
            forRemoval=true)
public Pre(@Nonnull
 ItemStack stack,
 @Nonnull
 List<? extends FormattedText> lines,
 PoseStack matrixStack,
 int x,
 int y,
 int screenWidth,
 int screenHeight,
 int maxWidth,
 @Nonnull
 Font fr)

Deprecated, for removal: This API element is subject to removal in a future version.

Pre

public Pre(@Nonnull
 ItemStack stack,
 PoseStack matrixStack,
 int x,
 int y,
 int screenWidth,
 int screenHeight,
 @Nonnull
 Font font,
 @Nonnull
 List<ClientTooltipComponent> components)

Method Details

getScreenWidth

public int getScreenWidth()

setScreenWidth

@Deprecated(since="1.18",
            forRemoval=true)
public void setScreenWidth(int screenWidth)

Deprecated, for removal: This API element is subject to removal in a future version.

getScreenHeight

public int getScreenHeight()

setScreenHeight

@Deprecated(since="1.18",
            forRemoval=true)
public void setScreenHeight(int screenHeight)

Deprecated, for removal: This API element is subject to removal in a future version.

getMaxWidth

@Deprecated(since="1.18",
            forRemoval=true)
public int getMaxWidth()

Deprecated, for removal: This API element is subject to removal in a future version.

use RenderTooltipEvent.GatherComponents

Returns:

The max width the tooltip can be. Defaults to -1 (unlimited).

setMaxWidth

@Deprecated(since="1.18",
            forRemoval=true)
public void setMaxWidth(int maxWidth)

Deprecated, for removal: This API element is subject to removal in a future version.

use RenderTooltipEvent.GatherComponents

Sets the max width of the tooltip. Use -1 for unlimited.

setFontRenderer

public void setFontRenderer(@Nonnull
 Font fr)

Sets the Font to be used to render text.

setX

public void setX(int x)

Set the X origin of the tooltip.

setY

public void setY(int y)

Set the Y origin of the tooltip.