Package net.minecraftforge.client.event

Class RenderTooltipEvent

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

  • Field Details

    • itemStack

      @NotNull protected final @NotNull ItemStack itemStack

    • graphics

      protected final GuiGraphics graphics

    • x

      protected int x

    • y

      protected int y

    • font

      protected Font font

    • components

      protected final List<ClientTooltipComponent> components

  • Constructor Details

  • Method Details

    • getItemStack

      @NotNull public @NotNull 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 GuiGraphics getGraphics()
      Returns the graphics helper for the gui.
      Returns:
      the graphics helper for the gui

    • getComponents

      @NotNull public @NotNull List<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

      @NotNull public @NotNull Font getFont()
      Returns The font used to render the text.
      Returns:
      The font used to render the text