Main   Class List   Namespace List   Wiki

SFXAmbience Class Reference
[Sound]

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

Inheritance diagram for SFXAmbience:
Inheritance graph
[legend]

List of all members.

Public Attributes

Sound

float dopplerFactor
 The factor to apply to the doppler affect in this space.
SFXEnvironment environment
 Reverb environment active in the ambience zone.
float rolloffFactor
 The rolloff factor to apply to distance-based volume attenuation in this space.
SFXTrack soundTrack
 Sound track to play in the ambience zone.
SFXState states [4]
 States to activate when the ambient zone is entered.

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:

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

Datablock_Networking


Member Data Documentation

The factor to apply to the doppler affect in this space.

Defaults to 0.5.

Doppler Effect

Reverb environment active in the ambience zone.

Audio Reverb

The rolloff factor to apply to distance-based volume attenuation in this space.

Defaults to 1.0.

Note:
This applies to the logarithmic distance model only.

Volume Attenuation

Sound track to play in the ambience zone.

States to activate when the ambient zone is entered.

When the ambient sound state is entered, all states associated with the state will be activated (given that they are not disabled) and deactivated when the space is exited again.



Copyright © GarageGames, LLC. All Rights Reserved.