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

Record Class AudioPlayData

java.lang.Object
java.lang.Record
com.csse3200.game.cutscene.models.object.actiondata.AudioPlayData
Record Components:
bus - The audio bus of the sound
sound - The sound object containing sound info (path & id)
volume - The render volume of the sound [0.0 .. 1.0]
pitch - The render pitch of the sound [>=0]
pan - The render pan of the sound (which ear it comes out of) [-1.0 .. 1.0]
loop - If the sound loops on completion (for background music)
await - Wait for audio completion before continuing
All Implemented Interfaces:
ActionData
public record AudioPlayData(AudioBus bus, Sound sound, Float volume, Float pitch, Float pan, boolean loop, boolean await) extends Record implements ActionData
Stores data for the audio.play event

  • Constructor Summary

    Constructors
    Constructor
    Description
    AudioPlayData(AudioBus bus, Sound sound, Float volume, Float pitch, Float pan, boolean loop, boolean await)
    Creates an instance of a AudioPlayData 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.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    loop()
    Returns the value of the loop record component.
    Float
    pan()
    Returns the value of the pan record component.
    Float
    pitch()
    Returns the value of the pitch record component.
    Sound
    sound()
    Returns the value of the sound record component.
    final String
    toString()
    Returns a string representation of this record class.
    Float
    volume()
    Returns the value of the volume record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AudioPlayData

      public AudioPlayData(AudioBus bus, Sound sound, Float volume, Float pitch, Float pan, boolean loop, boolean await)
      Creates an instance of a AudioPlayData record class.
      Parameters:
      bus - the value for the bus record component
      sound - the value for the sound record component
      volume - the value for the volume record component
      pitch - the value for the pitch record component
      pan - the value for the pan record component
      loop - the value for the loop 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

    • sound

      public Sound sound()
      Returns the value of the sound record component.
      Returns:
      the value of the sound record component

    • volume

      public Float volume()
      Returns the value of the volume record component.
      Returns:
      the value of the volume record component

    • pitch

      public Float pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component

    • pan

      public Float pan()
      Returns the value of the pan record component.
      Returns:
      the value of the pan record component

    • loop

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

    • await

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