Record Class DialogueChorusData

java.lang.Object
java.lang.Record
com.csse3200.game.cutscene.models.object.actiondata.DialogueChorusData
Record Components:
characters - A list of characters that "say" the text
text - The text that is being "said"
await - Wait for the text to finish displaying before continuing
All Implemented Interfaces:
ActionData

public record DialogueChorusData(List<Character> characters, String text, boolean await) extends Record implements ActionData
Stores the data for the dialogue.chorus event
  • Constructor Details

    • DialogueChorusData

      public DialogueChorusData(List<Character> characters, String text, boolean await)
      Creates an instance of a DialogueChorusData record class.
      Parameters:
      characters - the value for the characters record component
      text - the value for the text record component
      await - the value for the await 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • characters

      public List<Character> characters()
      Returns the value of the characters record component.
      Returns:
      the value of the characters record component
    • text

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

      public boolean await()
      Returns the value of the await record component.
      Returns:
      the value of the await record component