Package com.csse3200.game.ui.cutscene

Record Class CutsceneReaderComponent.TextBox

java.lang.Object
java.lang.Record
com.csse3200.game.ui.cutscene.CutsceneReaderComponent.TextBox
Record Components:
text - The text to be drawn inside the text box.
background - null means use the current background. Otherwise, can contain path to background asset to be used for this text box.
Enclosing class:
CutsceneReaderComponent
public static record CutsceneReaderComponent.TextBox(String text, String background) extends Record
Record object that represents information about a text box.

  • Constructor Details

    • TextBox

      public TextBox(String text, String background)
      Creates an instance of a TextBox record class.
      Parameters:
      text - the value for the text record component
      background - the value for the background 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.

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • background

      public String background()
      Returns the value of the background record component.
      Returns:
      the value of the background record component