SFXAmbience
Engine/source/sfx/sfxAmbience.h
Datablock for describing an ambient audio space.
Protected Attributes
Doppler shift factor for this space.
Reverb environment to apply when inside the ambient space.
Rolloff factor for this space. Only applies to logarithmic distance model.
SFXTrack *
Sound track to play when inside the ambient space.
Protected Static Attributes
Public Functions
DECLARE_CATEGORY("SFX" )
DECLARE_DESCRIPTION("An ambient sound environment." )
Return the doppler shift factor to apply in this space.
Return the reverb environment of the ambient space.
Return the rolloff factor to apply to distance-based volume attenuation in this space (logarithmic distance model only).
SFXTrack *
Return the ambient soundtrack of this ambient space.
Called after any property of the object is changed in the world editor.
bool
onAdd()
Called when the object is added to the sim.
bool
unpackData(BitStream * stream)
Public Static Functions
Detailed Description
Datablock for describing an ambient audio space.
Public Types
@165
Enumerator
- MaxStates = 4
Maximum number of states that can be tied to an ambient space.
typedef Signal< void(SFXAmbience *) > ChangeSignal
typedef SimDataBlock Parent
Protected Attributes
F32 mDopplerFactor
Doppler shift factor for this space.
SFXEnvironment * mEnvironment
Reverb environment to apply when inside the ambient space.
F32 mRolloffFactor
Rolloff factor for this space. Only applies to logarithmic distance model.
SFXTrack * mSoundTrack
Sound track to play when inside the ambient space.
SFXState * mState [MaxStates]
SFXStates to activate when in this ambient space.
Protected Static Attributes
ChangeSignal smChangeSignal
Public Functions
SFXAmbience()
DECLARE_CATEGORY("SFX" )
DECLARE_CONOBJECT(SFXAmbience )
DECLARE_DESCRIPTION("An ambient sound environment." )
getDopplerFactor()
Return the doppler shift factor to apply in this space.
getEnvironment()
Return the reverb environment of the ambient space.
getRolloffFactor()
Return the rolloff factor to apply to distance-based volume attenuation in this space (logarithmic distance model only).
getSoundTrack()
Return the ambient soundtrack of this ambient space.
getState(U32 i)
Return the given state bound to this ambient space.
inspectPostApply()
Reimplemented from: SimObject
onAdd()
Reimplemented from: SimDataBlock
packData(BitStream * stream)
Reimplemented from: SimDataBlock
preload(bool server, String & errorStr)
Reimplemented from: SimDataBlock
unpackData(BitStream * stream)
Reimplemented from: SimDataBlock
validate()
Ensure all properties of this ambience adhere to their value contraints.