Torque 3D - Script Manual: SFXFMODEventGroup Class Reference

TorqueScript

Main   Class List   Namespace List   Online

SFXFMODEventGroup Class Reference
[FMOD]

A group of events in an imported FMOD Designer project. More...

Inheritance diagram for SFXFMODEventGroup:

List of all members.

Public Member Functions

void freeData ()
 Release the resource data for this group and its subgroups.
bool isDataLoaded ()
 Test whether the resource data for this group has been loaded.
bool loadData (bool loadStreams=true, bool loadSamples=true)
 Load the resource data for this group, if it has not already been loaded (either directly or indirectly through a parent group).

Public Attributes

DO NOT MODIFY!!

SFXFMODEventGroup fmodGroup
 DO NOT MODIFY!!
string fmodName
 DO NOT MODIFY!!
SFXFMODProject fmodProject
 DO NOT MODIFY!!

Detailed Description

A group of events in an imported FMOD Designer project.

Note:
Instances of this class

Member Function Documentation

void SFXFMODEventGroup::freeData (  ) 

Release the resource data for this group and its subgroups.

See also:
SFXFMODProject_resources
bool SFXFMODEventGroup::isDataLoaded (  ) 

Test whether the resource data for this group has been loaded.

Returns:
True if the resource data for this group is currently loaded.
bool SFXFMODEventGroup::loadData ( bool  loadStreams = true,
bool  loadSamples = true 
)

Load the resource data for this group, if it has not already been loaded (either directly or indirectly through a parent group).

This method works recursively and thus data for direct and indirect child groups to this group will be loaded as well.

Parameters:
loadStreams Whether to open streams.
loadSamples Whether to load sample banks.
Returns:
True if the data has been successfully loaded; false otherwise.
See also:
SFXFMODProject_resources

Member Data Documentation

DO NOT MODIFY!!



Copyright © GarageGames, LLC. All Rights Reserved.