Package com.csse3200.game.cutscene.models.object.actiondata

Record Class CharacterEnterData

java.lang.Object
java.lang.Record
com.csse3200.game.cutscene.models.object.actiondata.CharacterEnterData
Record Components:
character - The character object containing character info (id, name, and poses)
pose - The pose the character will be rendered in
position - The position on screen the character will be rendered in
transition - The transition that happens to the character sprite
duration - How long the transition will take
await - Wait for the transition to complete before continuing
All Implemented Interfaces:
ActionData
public record CharacterEnterData(Character character, String pose, Position position, Transition transition, int duration, boolean await) extends Record implements ActionData
Stores data for the character.enter event

  • Constructor Details

    • CharacterEnterData

      public CharacterEnterData(Character character, String pose, Position position, Transition transition, int duration, boolean await)
      Creates an instance of a CharacterEnterData record class.
      Parameters:
      character - the value for the character record component
      pose - the value for the pose record component
      position - the value for the position record component
      transition - the value for the transition record component
      duration - the value for the duration 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.

    • character

      public Character character()
      Returns the value of the character record component.
      Returns:
      the value of the character record component

    • pose

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

    • position

      public Position position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • transition

      public Transition transition()
      Returns the value of the transition record component.
      Returns:
      the value of the transition record component

    • duration

      public int duration()
      Returns the value of the duration record component.
      Returns:
      the value of the duration record component

    • await

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