Interface ItemOverlayRenderer


public interface ItemOverlayRenderer
  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    Registers an overlay renderer that may be applied to any item.
    static void
    addRenderer(net.minecraft.item.Item item, ItemOverlayRenderer renderer)
    Registers an overlay renderer for a specific item.
    default boolean
    isActive(net.minecraft.item.ItemStack stack)
    If this renderer will currently render anything with this stack.
    static void
    Removes the given overlay renderer.
    void
    render(net.minecraft.item.ItemStack stack, net.minecraft.client.gui.DrawContext drawContext)
    Renders over an item in a GUI.
    default boolean
    renderInFront(net.minecraft.item.ItemStack stack)
    If this renderer should render in front of or behind the item.
  • Method Details

    • render

      void render(net.minecraft.item.ItemStack stack, net.minecraft.client.gui.DrawContext drawContext)
      Renders over an item in a GUI.
      Parameters:
      stack - itemstack to render over
      drawContext - provides a useable vertex consumer and a matrixstack positioned at the top left of the item slot.
    • isActive

      default boolean isActive(net.minecraft.item.ItemStack stack)
      If this renderer will currently render anything with this stack.
    • renderInFront

      default boolean renderInFront(net.minecraft.item.ItemStack stack)
      If this renderer should render in front of or behind the item.
    • addRenderer

      static void addRenderer(net.minecraft.item.Item item, ItemOverlayRenderer renderer)
      Registers an overlay renderer for a specific item.
    • addRenderer

      static void addRenderer(ItemOverlayRenderer renderer)
      Registers an overlay renderer that may be applied to any item. This should be used sparingly as it will be checked for every GUI item rendered! isActive() should be used to filter here as much as possible.
    • removeRenderer

      static void removeRenderer(ItemOverlayRenderer renderer)
      Removes the given overlay renderer. This is intended for configurable renderers to avoid running unnecessarily.