Package net.neoforged.neoforge.client.event

Class RenderTooltipEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.RenderTooltipEvent
Direct Known Subclasses:
RenderTooltipEvent.Pre, RenderTooltipEvent.Texture
public abstract class RenderTooltipEvent extends net.neoforged.bus.api.Event
Fired during tooltip rendering. See the various subclasses for listening to specific events.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    RenderTooltipEvent.GatherComponents
    Fired when a tooltip gathers the TooltipComponents to be rendered, before any text wrapping or processing.
    static class 
    RenderTooltipEvent.Pre
    Fired before the tooltip is rendered.
    static class 
    RenderTooltipEvent.Texture
    Fired when the textures for the tooltip background are determined.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent>
    components
     
    protected net.minecraft.client.gui.Font
    font
     
    protected final net.minecraft.client.gui.GuiGraphics
    graphics
     
    protected final net.minecraft.world.item.ItemStack
    itemStack
     
    protected int
    x
     
    protected int
    y
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RenderTooltipEvent(net.minecraft.world.item.ItemStack itemStack, 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)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent>
    getComponents()
    Returns the unmodifiable list of tooltip components.
    net.minecraft.client.gui.Font
    getFont()
    Returns The font used to render the text.
    net.minecraft.client.gui.GuiGraphics
    getGraphics()
    Returns the graphics helper for the gui.
    net.minecraft.world.item.ItemStack
    getItemStack()
    Returns the item stack which the tooltip is being rendered for, or an empty item stack if there is no associated item stack.
    int
    getX()
    Returns the X position of the tooltip box.
    int
    getY()
    Returns the Y position of the tooltip box.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • itemStack

      protected final net.minecraft.world.item.ItemStack itemStack

    • graphics

      protected final net.minecraft.client.gui.GuiGraphics graphics

    • x

      protected int x

    • y

      protected int y

    • font

      protected net.minecraft.client.gui.Font font

    • components

      protected final List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> components

  • Constructor Details

    • RenderTooltipEvent

      @Internal protected RenderTooltipEvent(net.minecraft.world.item.ItemStack itemStack, 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)

  • Method Details

    • getItemStack

      public net.minecraft.world.item.ItemStack getItemStack()
      Returns the item stack which the tooltip is being rendered for, or an empty item stack if there is no associated item stack.
      Returns:
      the item stack which the tooltip is being rendered for, or an empty item stack if there is no associated item stack

    • getGraphics

      public net.minecraft.client.gui.GuiGraphics getGraphics()
      Returns the graphics helper for the gui.
      Returns:
      the graphics helper for the gui

    • getComponents

      public List<net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> getComponents()
      Returns the unmodifiable list of tooltip components.

      Use ItemTooltipEvent or RenderTooltipEvent.GatherComponents to modify tooltip contents or components.

      Returns:
      the unmodifiable list of tooltip components

    • getX

      public int getX()
      Returns the X position of the tooltip box. By default, this is the mouse X position.
      Returns:
      the X position of the tooltip box

    • getY

      public int getY()
      Returns the Y position of the tooltip box. By default, this is the mouse Y position.
      Returns:
      the Y position of the tooltip box

    • getFont

      public net.minecraft.client.gui.Font getFont()
      Returns The font used to render the text.
      Returns:
      The font used to render the text