SFXAmbience Class Reference
[Sound]

A datablock that describes an ambient sound space. More...

[legend]

List of all members.

Detailed Description

A datablock that describes an ambient sound space.

Each ambience datablock captures the properties of a unique ambient sound space. A sound space is comprised of:

• an ambient audio track that is played when the listener is inside the space,
• a reverb environment that is active inside the space, and
• a number of SFXStates that are activated when entering the space and deactivated when exiting it.

Each of these properties is optional.

An important characteristic of ambient audio spaces is that their unique nature is not determined by their location in space but rather by their SFXAmbience datablock. This means that the same SFXAmbience datablock assigned to multiple locations in a level represents the same unique audio space to the sound system.

This is an important distinction for the ambient sound mixer which will activate a given ambient audio space only once at any one time regardless of how many intersecting audio spaces with the same SFXAmbience datablock assigned the listener may currently be in.

All SFXAmbience instances are automatically added to the global SFXAmbienceSet.

At the moment, transitions between reverb environments are not blended and different reverb environments from multiple active SFXAmbiences will not be blended together. This will be added in a future version.

Example:

singleton SFXAmbience( Underwater )
{
   environment = AudioEnvUnderwater;
   soundTrack = ScubaSoundList;
   states[ 0 ] = AudioLocationUnderwater;
};

See also:

SFXEnvironment

SFXTrack

SFXState

LevelInfo::soundAmbience

Zone::soundAmbience

Datablocks and Networking

Member Data Documentation