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

Record Class AudioStopData

java.lang.Object
java.lang.Record
com.csse3200.game.cutscene.models.object.actiondata.AudioStopData
Record Components:
bus - The audio bus of the sound
fadeMs - The time it takes for the music to fade out (0 for instant)
await - Wait for fade completion before continuing
All Implemented Interfaces:
ActionData
public record AudioStopData(AudioBus bus, int fadeMs, boolean await) extends Record implements ActionData
Stores the data for the audio.stop event

  • Constructor Summary

    Constructors
    Constructor
    Description
    AudioStopData(AudioBus bus, int fadeMs, boolean await)
    Creates an instance of a AudioStopData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    await()
    Returns the value of the await record component.
    AudioBus
    bus()
    Returns the value of the bus record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    fadeMs()
    Returns the value of the fadeMs record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AudioStopData

      public AudioStopData(AudioBus bus, int fadeMs, boolean await)
      Creates an instance of a AudioStopData record class.
      Parameters:
      bus - the value for the bus record component
      fadeMs - the value for the fadeMs 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.

    • bus

      public AudioBus bus()
      Returns the value of the bus record component.
      Returns:
      the value of the bus record component

    • fadeMs

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

    • await

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