Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Environment

Attach this to an Area, such as shape, box, solid, sphere, etc, to assign this environment to the Area. 

SettingDescription
EnvironmentThe environment you want to apply (the environment is created and set up in the Audio Controls Editor).
FadeDistanceDistance between Audio Listener and the Area over which the Environment should fade (in engine units).

Listener

Functions similar to a microphone; you listen to the world audio from a Listener position. The most prominent use is to attach it to cameras.

The scale offset in relation to the entity. The linking symbol locks the scaling so that the values are relative to each other. For e.g. a value of 1,2,3, scaled by 2x would result in 2,4,6. (if unlocked then the scaling cannot be guaranteed). 
SettingDescription
TranslationThe positional offset in relation to the entity - for example a value of 0,0,1 will mean an offset of one unit upwards (Z axis).
RotationThe rotation offset in relation to the entity.
ScaleNameName of the audio listener.
OffsetOffset of the listener position.

Trigger

Barebone Audio Trigger that handles Audio Triggers created in the Audio Controls Editor.

SettingDescription
Play


SettingDescription
AutoPLayAutoPlayEnabled by default. When disabled, the trigger will be executed and stopped immediately after the component has been created.
PlayTriggerThis trigger is executed when Play is called.


Stop


SettingDescription
Can StopEnabled by default. Defines if the trigger can be stopped by the Stop Trigger content.
Stop triggerAvailable is Can Stop is set to Stop. This trigger is executed when Stop is called.


Debug


SettingDescription
PlayExecutes the PlayTrigger
StopStops the PlayTrigger if no StopTrigger is assigned - otherwise executes the StopTrigger.
Draw PlayTrigger Radius

Shows the radius of the PlayTrigger if there is any radius information for the 3D sound.

Info
Not all audio middleware implementations support this; it currently works for Wwise and SDL Mixer.


Draw StopTrigger Radius

Shows the radius of the StopTrigger if there is any radius information for the 3D sound.

Info
Not all audio middleware implementations support this; it currently works for Wwise and SDL Mixer.



For more information about Play/Stop behavior, please refer to the Play/Stop Behavior page.

On This Page

Table of Contents
maxLevel4
minLevel2