Torque Game Engine Documentation
TGE Version 1.5.2

AudioProfile Class Reference

#include <audioDataBlock.h>

Inheritance diagram for AudioProfile:


Public Member Functions
	AudioProfile ()
	DECLARE_CONOBJECT (AudioProfile)
virtual bool	onAdd ()
	Called when the object is added to the sim.
virtual void	packData (BitStream *stream)
virtual void	unpackData (BitStream *stream)
virtual bool	preload (bool server, char errorBuffer[256])
	Called to prepare the datablock for use, after it has been unpacked.
const Audio::Description *	getDescription () const
bool	isPreload ()
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
U32	mDescriptionObjectID
AudioDescription *	mDescriptionObject
AudioSampleEnvironment *	mSampleEnvironment
StringTableEntry	mFilename
bool	mPreload
Private Types
typedef SimDataBlock	Parent
Private Attributes
Resource< AudioBuffer >	mBuffer

Member Typedef Documentation

Reimplemented from SimDataBlock.

AudioProfile::AudioProfile ( )

AudioProfile::DECLARE_CONOBJECT ( AudioProfile )

static void AudioProfile::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from SimObject.

virtual bool AudioProfile::onAdd ( ) [virtual]

Called when the object is added to the sim.

Reimplemented from SimDataBlock.

virtual void AudioProfile::packData ( BitStream * stream ) [virtual]

Reimplemented from SimDataBlock.

virtual void AudioProfile::unpackData ( BitStream * stream ) [virtual]

Reimplemented from SimDataBlock.

virtual bool AudioProfile::preload	(	bool	server,
		char	errorBuffer[256]
	)			`[virtual]`

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

Parameters:

	server	Set if we're running on the server (and therefore don't need to load things like textures or sounds).
	errorBuffer	If an error occurs in loading, this is set to a short string describing the error.