Record Class RenderContext

java.lang.Object
java.lang.Record
de.Keyle.MyPet.api.gui.RenderContext
Record Components:
viewer - who the menu is being drawn for
instance - the open menu being rendered
catalog - collects the placeholders this render resolves

public record RenderContext(Player viewer, MenuInstance instance, PlaceholderCatalog catalog) extends Record
Per-render scratchpad. Renderers read state via the instance and supply placeholders for any text they render. The catalog is rebuilt fresh on each render(...) call.
  • Constructor Details

    • RenderContext

      public RenderContext(Player viewer, MenuInstance instance, PlaceholderCatalog catalog)
      Creates an instance of a RenderContext record class.
      Parameters:
      viewer - the value for the viewer record component
      instance - the value for the instance record component
      catalog - the value for the catalog 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.
    • viewer

      public Player viewer()
      Returns the value of the viewer record component.
      Returns:
      the value of the viewer record component
    • instance

      public MenuInstance instance()
      Returns the value of the instance record component.
      Returns:
      the value of the instance record component
    • catalog

      public PlaceholderCatalog catalog()
      Returns the value of the catalog record component.
      Returns:
      the value of the catalog record component