User Manual

Sound

The Sound component controls playback of audio samples.

Sound component

Each Sound component contains "Slots" that are responsible for playing sounds. Each Slot can be assigned a different audio Asset, and can be played independently from the other Slots.

You can add a new Slot by clicking on the "ADD SLOT" button. You can remove a Slot by clicking on the bin icon in the header of each slot.

The Sound component can be enabled or disabled using the toggle in the top right of the component panel. If enabled, the component will play the Slots that are marked as Auto Play. The rest of the Slots can be played by scripts.

Component Properties

PropertyDescription
PositionalIf checked, the component will play back audio assets as if played from the location of the entity in 3D space.
VolumeThe volume that will be multiplied with the volume of each Slot when playing an audio asset.
PitchThe pitch that will be multiplied with the pitch of each Slot when playing an audio asset. A value of 1 means the audio is played back at the original pitch.
Ref DistanceThe reference distance for reducing volume as the sound source moves further from the listener.
Max DistanceThe maximum distance from the listener at which audio falloff stops. Note the volume of the audio is not necessarily 0 after this distance, but just doesn't fall off anymore.
Distance ModelDetermines which algorithm to use to reduce the volume of the sound as it moves away from the listener. Can be one of Linear, Inverse or Exponential.
Roll-off FactorThe rate at which volume fall-off occurs.

Slot Properties

PropertyDescription
NameThe name of the Slot. This is the name that you will use to refer to this Slot in code.
AssetThe audio asset to play.
Range StartThe starting point of the sound in the audio asset, in seconds. You can use this if you don't want to play the entire audio asset but just a portion of it instead.
Range DurationThe duration of the sound to play starting from Range Start, in seconds. E.g. you might have an audio asset with multiple sounds in it. To make this Slot play such a sound you can define its Start time and its Duration.
Auto PlayIf checked, the Slot will be played on load. Otherwise, the Slot will need to be played using script.
OverlapIf checked, this Slot will play its sound without stopping first. Overlap should be used for one-shot sounds that need to be played repeatedly. Overlapping sounds do not stop when the Entity is destroyed, but only when they finish or when you manually stop them in script.
LoopIf checked, the Slot will loop continuously. Otherwise, it will be played once to completion.
VolumeThe volume of the audio asset played back by the slot.
PitchThe pitch at which the audio is played. A value of 1 means the audio is played back at the original pitch.

Scripting Interface

You can control the properties of a Sound component using a script component. The scripting interface for the Sound component is here.