Package net.minecraftforge.client.gui.overlay

Record Class NamedGuiOverlay

java.lang.Object
java.lang.Record
net.minecraftforge.client.gui.overlay.NamedGuiOverlay
public record NamedGuiOverlay(ResourceLocation id, IGuiOverlay overlay) extends Record
An object representation of an overlay with a name.

Useful to identify overlays in RenderGuiOverlayEvent.

Users should not be instantiating this themselves. Retrieve from GuiOverlayManager.

  • Field Details

    • id

      private final ResourceLocation id
      The field for the id record component.

    • overlay

      private final IGuiOverlay overlay
      The field for the overlay record component.

  • Constructor Details

    • NamedGuiOverlay

      @Internal public NamedGuiOverlay(ResourceLocation id, IGuiOverlay overlay)
      Creates an instance of a NamedGuiOverlay record class.
      Parameters:
      id - the value for the id record component
      overlay - the value for the overlay record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public ResourceLocation id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • overlay

      public IGuiOverlay overlay()
      Returns the value of the overlay record component.
      Returns:
      the value of the overlay record component