A gain multiplier in the range [0,1] applied to all sounds playing in the Game.
Play a Sound at the end of this frame.
The Sound resource to play.
How loudly to play the sound. In the range [0,1]. Default value: 1.0
A playback speed multiplier in the range (0,8]. Default value: 1.0
An offset in seconds to start playback at in the sound. Default value: 0.0
Whether the Sound should loop continuously or not. Default value: false
How many seconds into the sound to jump to after a loop finishes.
How many seconds into the sound to play before looping back to loopStart
.
Play a Sound at the end of this frame. The Sound will emanate from the specified Entity.
The Sound resource to play.
Which Entity the playing Sound should emanate from.
Specifies what to do if the Entity is removed while the Sound is playing. Default value: SoundStopPolicy.Immediate
How loudly to play the sound. In the range [0,1]. Default value: 1.0
A playback speed multiplier in the range (0,8]. Default value: 1.0
An offset in seconds to start playback at in the sound. Default value: 0.0
Whether the Sound should loop continuously or not. Default value: false
Where in seconds playback should return to when the Sound loops. Default value: 0.0
Where in seconds playback should loop. A value of zero means the sound will loop at the end. Default value: 0.0
Describes how quickly gain should be reduced when moving away from the listener. Its range depends on the distanceModel
used (negative values are not allowed).
SoundDistanceModel.Linear
: The range is 0 to 1.SoundDistanceModel.Inverse
: The range is 0 to Infinity.SoundDistanceModel.Exponential
: The range is 0 to Infinity.
Default value: 1.0
The distance from position
within which the sound will be at normal gain. Must be a non-negative number. Default value: 300
Represents the maximum distance between the audio source and the listener, outside which the gain is not reduced any further. This property is only used when using SoundDistanceModel.Linear
for distanceModel
. Must be a positive non-zero number. Default value: 800
Specifies how the Sound's gain should change based on its distance from the audio listener. Default value: SoundDistanceModel.Linear
Play a Sound at the end of this frame. The Sound will emanate from the specified location in world space.
The Sound resource to play.
The coordinate in world space where the Sound should emanate from.
How loudly to play the sound. In the range [0,1]. Default value: 1.0
A playback speed multiplier in the range (0,8]. Default value: 1.0
An offset in seconds to start playback at in the sound. Default value: 0.0
Whether the Sound should loop continuously or not. Default value: false
Where in seconds playback should return to when the Sound loops. Default value: 0.0
Where in seconds playback should loop. A value of zero means the sound will loop at the end. Default value: 0.0
Describes how quickly gain should be reduced when moving away from the listener. Its range depends on the distanceModel
used (negative values are not allowed).
SoundDistanceModel.Linear
: The range is 0 to 1.SoundDistanceModel.Inverse
: The range is 0 to Infinity.SoundDistanceModel.Exponential
: The range is 0 to Infinity.
Default value: 1.0
The distance from position
within which the sound will be at normal gain. Must be a non-negative number. Default value: 300
Represents the maximum distance between the audio source and the listener, outside which the gain is not reduced any further. This property is only used when using SoundDistanceModel.Linear
for distanceModel
. Must be a positive non-zero number. Default value: 800
Specifies how the Sound's gain should change based on its distance from the audio listener. Default value: SoundDistanceModel.Linear
Set the location of the audio listener in world space.
The coordinate to set.
A gain multiplier in the range [0,1] applied to all sounds playing in the Game.