Torque3D Documentation / _generateds / SceneAmbientSoundObject

SceneAmbientSoundObject

Engine/source/scene/mixin/sceneAmbientSoundObject.h

Template mixin to add ability to hold a custom SFXAmbience to a SceneObject.

More...

Protected Types

enum
_Anonymous_ {
  SoundMask = Parent::NextFreeMask << 0
  NextFreeMask = Parent::NextFreeMask << 1
}

Public Types

Base

Parent

Protected Attributes

SFXAmbience *

mSoundAmbience

Ambient sound properties for this space.

Public Functions

SceneAmbientSoundObject()

SFXAmbience *

getSoundAmbience()

U32

packUpdate(NetConnection * connection, U32 mask, BitStream * stream)

void

setSoundAmbience(SFXAmbience * ambience)

Set the ambient sound properties for the space.
void

unpackUpdate(NetConnection * connection, BitStream * stream)

Public Static Functions
void

initPersistFields()

Private Static Functions
bool

_setSoundAmbience(void * object, const char * index, const char * data)

Detailed Description
Template mixin to add ability to hold a custom SFXAmbience to a SceneObject.
Protected Types
@153

Enumerator
SoundMask = Parent::NextFreeMask << 0
Ambient sound properties have changed.
NextFreeMask = Parent::NextFreeMask << 1
Public Types
typedef Base Parent 

Protected Attributes
SFXAmbience * mSoundAmbience 

Ambient sound properties for this space.
Public Functions
SceneAmbientSoundObject()

getSoundAmbience()

packUpdate(NetConnection * connection, U32 mask, BitStream * stream)

Reimplemented by: Portal
setSoundAmbience(SFXAmbience * ambience)

Set the ambient sound properties for the space.
unpackUpdate(NetConnection * connection, BitStream * stream)

Reimplemented by: Portal
Public Static Functions
initPersistFields()

Private Static Functions
_setSoundAmbience(void * object, const char * index, const char * data)