Class RenderTooltipEvent.Texture

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.RenderTooltipEvent

net.neoforged.neoforge.client.event.RenderTooltipEvent.Texture

Enclosing class:

RenderTooltipEvent

public static class RenderTooltipEvent.Texture
extends RenderTooltipEvent

Fired when the textures for the tooltip background are determined. This can be used to modify the background and frame texture.

This event is not cancellable.

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

Nested Class Summary

Nested classes/interfaces inherited from class RenderTooltipEvent

RenderTooltipEvent.GatherComponents, RenderTooltipEvent.Pre, RenderTooltipEvent.Texture

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable Identifier	originalTexture
private @Nullable Identifier	texture

Fields inherited from class RenderTooltipEvent

components, font, graphics, itemStack, x, y

Constructor Summary

Constructors

Constructor	Description
Texture(ItemStack stack, GuiGraphicsExtractor graphics, int x, int y, Font font, List<ClientTooltipComponent> components, @Nullable Identifier texture)

Method Summary

Modifier and Type	Method	Description
@Nullable Identifier	getOriginalTexture()	Returns the original texture location given to the tooltip render method (may originate from DataComponents.TOOLTIP_STYLE).
@Nullable Identifier	getTexture()	Returns the texture location that will be used to render the tooltip.
void	setTexture(@Nullable Identifier texture)	Set the texture to use for the tooltip background and frame or null to use the default textures.

Methods inherited from class RenderTooltipEvent

getComponents, getFont, getGraphics, getItemStack, getX, getY

Methods inherited from class Object

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

Field Details

originalTexture

private final @Nullable Identifier originalTexture

texture

private @Nullable Identifier texture

Constructor Details

Texture

@Internal
public Texture(ItemStack stack,
 GuiGraphicsExtractor graphics,
 int x,
 int y,
 Font font,
 List<ClientTooltipComponent> components,
 @Nullable Identifier texture)

Method Details

getOriginalTexture

public @Nullable Identifier getOriginalTexture()

Returns the original texture location given to the tooltip render method (may originate from DataComponents.TOOLTIP_STYLE).

Returns:

the original texture location given to the tooltip render method (may originate from DataComponents.TOOLTIP_STYLE)

getTexture

public @Nullable Identifier getTexture()

Returns the texture location that will be used to render the tooltip.

Returns:

the texture location that will be used to render the tooltip

setTexture

public void setTexture(@Nullable Identifier texture)

Set the texture to use for the tooltip background and frame or null to use the default textures.

The given Identifier will be prefixed with tooltip/ and suffixed with _background and _frame to determine the background and frame texture respectively