Package net.neoforged.neoforge.client.event

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 net.neoforged.neoforge.client.event.RenderTooltipEvent

RenderTooltipEvent.GatherComponents, RenderTooltipEvent.Pre, RenderTooltipEvent.Texture

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable net.minecraft.resources.ResourceLocation	originalTexture
private @Nullable net.minecraft.resources.ResourceLocation	texture

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

components, font, graphics, itemStack, x, y

Constructor Summary

Constructors

Constructor	Description
Texture(net.minecraft.world.item.ItemStack stack, net.minecraft.client.gui.GuiGraphics graphics, int x, int y, net.minecraft.client.gui.Font font, List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> components, @Nullable net.minecraft.resources.ResourceLocation texture)

Method Summary

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

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

Field Details

originalTexture

@Nullable
private final @Nullable net.minecraft.resources.ResourceLocation originalTexture

texture

@Nullable
private @Nullable net.minecraft.resources.ResourceLocation texture

Constructor Details

Texture

@Internal
public Texture(net.minecraft.world.item.ItemStack stack,
 net.minecraft.client.gui.GuiGraphics graphics,
 int x,
 int y,
 net.minecraft.client.gui.Font font,
 List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> components,
 @Nullable
 @Nullable net.minecraft.resources.ResourceLocation texture)

Method Details

getOriginalTexture

@Nullable
public @Nullable net.minecraft.resources.ResourceLocation 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

@Nullable
public @Nullable net.minecraft.resources.ResourceLocation 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
 @Nullable net.minecraft.resources.ResourceLocation texture)

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

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