SFXTrack

Engine/source/sfx/sfxTrack.h

A datablock that describes sound data for playback.

More...

Public Types

enum
_Anonymous_ {  MaxNumParameters = 8
}
Parent 

Protected Attributes

The description which controls playback settings.

mParameters [MaxNumParameters]

Name of the parameters to which sources playing this track should connect.

Protected Functions

bool

Overload this to disable direct instantiation of this class via script 'new'.

Public Functions

SFXTrack(const SFXTrack & , bool )
SFXTrack(SFXDescription * description)
DECLARE_DESCRIPTION("Abstract base class <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> any kind of data that can be turned into SFXSources." )

Returns the description object for this sound profile.

Called after any property of the object is changed in the world editor.

bool

Called when the object is added to the sim.

bool
preload(bool server, String & errorStr)

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

setParameter(U32 index, const char * name)

Public Static Functions

Detailed Description

A datablock that describes sound data for playback.

Public Types

@173

Enumerator

MaxNumParameters = 8

Maximum numbers of parameters that can be pre-assigned to tracks.

typedef SimDataBlock Parent 

Protected Attributes

SFXDescription * mDescription 

The description which controls playback settings.

StringTableEntry mParameters [MaxNumParameters]

Name of the parameters to which sources playing this track should connect.

Protected Functions

processArguments(S32 argc, ConsoleValueRef * argv)

Reimplemented from: SimObject

Public Functions

SFXTrack()

SFXTrack(const SFXTrack & , bool )

SFXTrack(SFXDescription * description)

DECLARE_CATEGORY("SFX" )

DECLARE_CONOBJECT(SFXTrack )

DECLARE_DESCRIPTION("Abstract base class <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> any kind of data that can be turned into SFXSources." )

getDescription()

Returns the description object for this sound profile.

getParameter(U32 index)

inspectPostApply()

Reimplemented from: SimObject

Reimplemented by: SFXPlayList

onAdd()

Reimplemented from: SimDataBlock

Reimplemented by: SFXFMODEvent, SFXProfile

packData(BitStream * stream)

Reimplemented from: SimDataBlock

Reimplemented by: SFXFMODEvent, SFXPlayList, SFXProfile

preload(bool server, String & errorStr)

Reimplemented from: SimDataBlock

Reimplemented by: SFXFMODEvent, SFXPlayList, SFXProfile

setParameter(U32 index, const char * name)

unpackData(BitStream * stream)

Reimplemented from: SimDataBlock

Reimplemented by: SFXFMODEvent, SFXPlayList, SFXProfile

Public Static Functions

initPersistFields()