Torque3D Documentation / _generateds / SFXFMODEventGroup

SFXFMODEventGroup

Engine/source/sfx/fmod/sfxFMODEventGroup.h

More...

Public Types

Parent 

Public Friends

Protected Attributes

Public Functions

SFXFMODEventGroup(SFXFMODProject * project, FMOD_EVENTGROUP * handle, SFXFMODEventGroup * parent)
acquire(bool recursive)

Create the event group object on the FMOD device.

DECLARE_CATEGORY("SFX FMOD" )
DECLARE_DESCRIPTION("An event group in an FMOD Designer project." )
freeData(bool force)
bool

Return true if the event data for this group has been loaded.

bool
loadData(bool samples, bool streams)

Load the event data for this group.

bool

Called when the object is added to the sim.

Called when the object is removed from the sim.

bool
preload(bool server, String & errorStr)

Called to prepare the datablock for use, after it has been unpacked.

Release the event group object on the FMOD device.

Public Static Functions

Detailed Description

Public Types

typedef SimDataBlock Parent 

Public Friends

Protected Attributes

SFXFMODEventGroup * mChildren 
SFXFMODEvent * mEvents 
FMOD_EVENTGROUP * mHandle 
U32 mLoadCount 
String mName 
U32 mNumEvents 
U32 mNumGroups 
SFXFMODEventGroup * mParent 
S32 mParentId 

Project ID for client net sync.

SFXFMODProject * mProject 
S32 mProjectId 

Project ID for client net sync.

SFXFMODEventGroup * mSibling 

Protected Functions

_addEvent(SFXFMODEvent * event)

_addGroup(SFXFMODEventGroup * group)

_load()

_removeEvent(SFXFMODEvent * event)

_removeGroup(SFXFMODEventGroup * group)

Public Functions

SFXFMODEventGroup()

SFXFMODEventGroup(SFXFMODProject * project, const String & name, SFXFMODEventGroup * parent)

SFXFMODEventGroup(SFXFMODProject * project, FMOD_EVENTGROUP * handle, SFXFMODEventGroup * parent)

~SFXFMODEventGroup()

acquire(bool recursive)

Create the event group object on the FMOD device.

DECLARE_CATEGORY("SFX FMOD" )

DECLARE_CONOBJECT(SFXFMODEventGroup )

DECLARE_DESCRIPTION("An event group in an FMOD Designer project." )

freeData(bool force)

getGroupName()

getProject()

getQualifiedName()

isDataLoaded()

Return true if the event data for this group has been loaded.

loadData(bool samples, bool streams)

Load the event data for this group.

note:

Loading is reference-counted.

onAdd()

Reimplemented from: SimDataBlock

onRemove()

Reimplemented from: SimObject

packData(BitStream * stream)

Reimplemented from: SimDataBlock

preload(bool server, String & errorStr)

Reimplemented from: SimDataBlock

release()

Release the event group object on the FMOD device.

unpackData(BitStream * stream)

Reimplemented from: SimDataBlock

Public Static Functions

initPersistFields()