SFXFMODEvent
Engine/source/sfx/fmod/sfxFMODEvent.h
An event in an FMOD Designer project.
Public Types
Parent
Public Friends
class
class
Protected Attributes
Event group that this event belongs to.
FMOD_EVENT *
FMOD event handle when event is open. Client-side only.
mParameterRanges [MaxNumParameters]
mParameterValues [MaxNumParameters]
Next event in the group's event chain.
Protected Functions
Public Functions
SFXFMODEvent(SFXFMODEventGroup * group, const String & name)
SFXFMODEvent(SFXFMODEventGroup * group, FMOD_EVENT * handle)
DECLARE_CATEGORY("SFX FMOD" )
DECLARE_DESCRIPTION("An FMOD Designer event." )
bool
bool
onAdd()
Called when the object is added to the sim.
bool
unpackData(BitStream * stream)
Public Static Functions
Detailed Description
An event in an FMOD Designer project.
This class must not be manually instanced by the user. Instead, SFXFMODEvents are automatically created when an SFXFMODProject is loaded.
Be aware that as all the playback happens internally within FMOD's event system, this bypasses the SFX layer and will thus not work with features that rely the structures there. Namely, sound occlusion (except for FMOD's own occlusion) will not work with FMOD events.
The parameters of an FMOD event are automatically created and designed using the information in the project.
Public Types
typedef SFXTrack Parent
Public Friends
Protected Attributes
SFXFMODEventGroup * mGroup
Event group that this event belongs to.
S32 mGroupId
Group ID for client net sync.
FMOD_EVENT * mHandle
FMOD event handle when event is open. Client-side only.
String mName
Name of the event in the Designer project.
Point2F mParameterRanges [MaxNumParameters]
F32 mParameterValues [MaxNumParameters]
SFXFMODEvent * mSibling
Next event in the group's event chain.
Protected Functions
_createParameters()
Public Functions
SFXFMODEvent()
SFXFMODEvent(SFXFMODEventGroup * group, const String & name)
SFXFMODEvent(SFXFMODEventGroup * group, FMOD_EVENT * handle)
~SFXFMODEvent()
acquire()
Create the event object on the FMOD device.
DECLARE_CATEGORY("SFX FMOD" )
DECLARE_CONOBJECT(SFXFMODEvent )
DECLARE_DESCRIPTION("An FMOD Designer event." )
getEventGroup()
getEventName()
getQualifiedName()
isDataLoaded()
onAdd()
Reimplemented from: SFXTrack
onRemove()
Reimplemented from: SimObject
packData(BitStream * stream)
Reimplemented from: SFXTrack
preload(bool server, String & errorStr)
Reimplemented from: SFXTrack
release()
Release the event object on the FMOD device.
unpackData(BitStream * stream)
Reimplemented from: SFXTrack