Record Class NoticeDialog

java.lang.Object
java.lang.Record
fr.fidorial.dialog.NoticeDialog
Record Components:
base - the shared title, contents and behaviour
action - the only button of the dialog
All Implemented Interfaces:
Dialog, DialogDefinition, DialogLike
public record NoticeDialog(DialogBase base, DialogActionButton action) extends Record implements DialogDefinition
A dialog with a single button in its footer.
Since:
0.1.0
Since Minecraft:
1.21.6

  • Field Details

    • DEFAULT_ACTION

      public static final DialogActionButton DEFAULT_ACTION
      The button vanilla falls back to: a plain gui.ok that only dismisses the dialog.
      Since:
      0.1.0

  • Constructor Details

    • NoticeDialog

      public NoticeDialog(DialogBase base, DialogActionButton action)
      Creates an instance of a NoticeDialog record class.
      Parameters:
      base - the value for the base record component
      action - the value for the action record component

  • Method Details

    • of

      @Contract("_ -> new") public static NoticeDialog of(DialogBase base)
      Creates a notice whose button reads gui.ok and only dismisses the dialog.
      Parameters:
      base - the shared title, contents and behaviour
      Returns:
      the dialog
      Since:
      0.1.0

    • 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.

    • base

      public DialogBase base()
      Returns the value of the base record component.
      Specified by:
      base in interface DialogDefinition
      Returns:
      the value of the base record component

    • action

      public DialogActionButton action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component