Package net.neoforged.neoforge.client.event

Class RegisterGuiLayersEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.RegisterGuiLayersEvent
All Implemented Interfaces:
net.neoforged.fml.event.IModBusEvent
public class RegisterGuiLayersEvent extends net.neoforged.bus.api.Event implements net.neoforged.fml.event.IModBusEvent
Allows users to register custom layers for GUI rendering.

See also RenderGuiLayerEvent to intercept rendering of registered layers.

This event is not cancellable, and does not

invalid reference 
have a result
.

This event is fired on the mod-specific event bus, only on the logical client.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    private static enum 
    RegisterGuiLayersEvent.Ordering
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final List<GuiLayerManager.NamedLayer>
    layers
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    RegisterGuiLayersEvent(List<GuiLayerManager.NamedLayer> layers)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    private void
    register(RegisterGuiLayersEvent.Ordering ordering, @Nullable net.minecraft.resources.ResourceLocation other, net.minecraft.resources.ResourceLocation key, net.minecraft.client.gui.LayeredDraw.Layer layer)
     
    void
    registerAbove(net.minecraft.resources.ResourceLocation other, net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
    Registers an layer that renders above another.
    void
    registerAboveAll(net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
    Registers a layer that renders above all others.
    void
    registerBelow(net.minecraft.resources.ResourceLocation other, net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
    Registers a layer that renders below another.
    void
    registerBelowAll(net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
    Registers a layer that renders below all others.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • registerBelowAll

      public void registerBelowAll(net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
      Registers a layer that renders below all others.
      Parameters:
      id - A unique resource id for this layer
      layer - The layer

    • registerBelow

      public void registerBelow(net.minecraft.resources.ResourceLocation other, net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
      Registers a layer that renders below another.
      Parameters:
      other - The id of the layer to render below. This must be a layer you have already registered or one of the vanilla layers. Do not use other mods' layers.
      id - A unique resource id for this layer
      layer - The layer

    • registerAbove

      public void registerAbove(net.minecraft.resources.ResourceLocation other, net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
      Registers an layer that renders above another.
      Parameters:
      other - The id of the layer to render above. This must be a layer you have already registered or one of the vanilla layers. Do not use other mods' layers.
      id - A unique resource id for this layer
      layer - The layer

    • registerAboveAll

      public void registerAboveAll(net.minecraft.resources.ResourceLocation id, net.minecraft.client.gui.LayeredDraw.Layer layer)
      Registers a layer that renders above all others.
      Parameters:
      id - A unique resource id for this layer
      layer - The layer

    • register

      private void register(RegisterGuiLayersEvent.Ordering ordering, @Nullable @Nullable net.minecraft.resources.ResourceLocation other, net.minecraft.resources.ResourceLocation key, net.minecraft.client.gui.LayeredDraw.Layer layer)