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

Record Class AudioSetData

java.lang.Object
java.lang.Record
com.csse3200.game.cutscene.models.object.actiondata.AudioSetData
Record Components:
bus - The audio bus of the sound
volume - The render volume of the sound [0.0 .. 1.0]
All Implemented Interfaces:
ActionData
public record AudioSetData(AudioBus bus, Float volume) extends Record implements ActionData
Stores data for the audio.set event

  • Constructor Summary

    Constructors
    Constructor
    Description
    AudioSetData(AudioBus bus, Float volume)
    Creates an instance of a AudioSetData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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

    • AudioSetData

      public AudioSetData(AudioBus bus, Float volume)
      Creates an instance of a AudioSetData record class.
      Parameters:
      bus - the value for the bus record component
      volume - the value for the volume 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.

    • bus

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

    • volume

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