#include <AudioAsset.h>

Inheritance diagram for AudioAsset:

Public Member Functions
	AudioAsset ()

virtual void	copyTo (SimObject *object)

void	setAudioFile (const char *pAudioFile)

StringTableEntry	getAudioFile (void) const

void	setVolume (const F32 volume)

F32	getVolume (void) const

void	setVolumeChannel (const S32 volumeChannel)

S32	getVolumeChannel (void) const

void	setLooping (const bool looping)

bool	getLooping (void) const

void	setStreaming (const bool streaming)

bool	getStreaming (void) const

void	setDescription (const Audio::Description &audioDescription)

const Audio::Description &	getAudioDescription (void) const

	DECLARE_CONOBJECT (AudioAsset)

Public Member Functions inherited from AssetBase
	AssetBase ()

virtual	~AssetBase ()

void	setAssetName (const char *pAssetName)
	Asset configuration. More...

StringTableEntry	getAssetName (void) const

void	setAssetDescription (const char *pAssetDescription)

StringTableEntry	getAssetDescription (void) const

void	setAssetCategory (const char *pAssetCategory)

StringTableEntry	getAssetCategory (void) const

void	setAssetAutoUnload (const bool autoUnload)

bool	getAssetAutoUnload (void) const

void	setAssetInternal (const bool assetInternal)

bool	getAssetInternal (void) const

bool	getAssetPrivate (void) const

StringTableEntry	getAssetType (void) const

S32	getAcquiredReferenceCount (void) const

bool	getOwned (void) const

StringTableEntry	getAssetId (void) const

StringTableEntry	expandAssetFilePath (const char *pAssetFilePath) const
	Expanding/Collapsing asset paths is only available once registered with the asset manager. More...

StringTableEntry	collapseAssetFilePath (const char *pAssetFilePath) const

virtual bool	isAssetValid (void) const

void	refreshAsset (void)

	DECLARE_CONOBJECT (AssetBase)
	Declare Console Object. More...

Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const

StringTableEntry	getSuperClassNamespace () const

void	setClassNamespace (const char *classNamespace)

void	setSuperClassNamespace (const char *superClassNamespace)

void	pushScriptCallbackGuard (void)

void	popScriptCallbackGuard (void)

S32	getScriptCallbackGuard (void)

virtual SimObject *	findObject (const char *name)

Namespace *	getNamespace ()
	Return the object's namespace. More...

const char *	tabComplete (const char *prevText, S32 baseLen, bool)

virtual void	dump ()

virtual void	dumpClassHierarchy ()

SimObject *	clone (const bool copyDynamicFields)

template<typename T >
bool	isType (void)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)

	DECLARE_CONOBJECT (SimObject)

Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list. More...

void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted. More...

void	clearNotify (SimObject *obj)
	Notify an object when we are cleared. More...

void	clearAllNotifications ()
	Remove all notifications for this object. More...

void	processDeleteNotifies ()
	Send out deletion notifications. More...

void	registerReference (SimObject **obj)

void	unregisterReference (SimObject **obj)

const char *	getDataField (StringTableEntry slotName, const char *array)

void	setDataField (StringTableEntry slotName, const char array, const char value)

const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)

void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)

const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)

void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)

StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)

U32	getDataFieldType (StringTableEntry slotName, const char *array)

SimFieldDictionary *	getFieldDictionary ()

void	clearDynamicFields (void)
	Clear all dynamic fields. More...

void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true. More...

bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true. More...

void	setInternalName (const char *newname)

StringTableEntry	getInternalName ()
	Get the internal of of this control. More...

virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File. More...

virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace. More...

SimObjectId	getId (void) const

StringTableEntry	getIdString (void) const

U32	getType () const

const StringTableEntry	getName (void) const

void	setId (SimObjectId id)

void	assignName (const char *name)

SimGroup *	getGroup () const

bool	isChildOfGroup (SimGroup *pGroup)

bool	isProperlyAdded () const

bool	isDeleted () const

bool	isRemoved () const

bool	isLocked ()

void	setLocked (bool b)

bool	isHidden ()

void	setHidden (bool b)

void	setProgenitorFile (const char *pFile)

StringTableEntry	getProgenitorFile (void) const

void	setPeriodicTimerID (const S32 timerID)

S32	getPeriodicTimerID (void) const

bool	isPeriodicTimerActive (void) const

bool	isSelected () const

bool	isExpanded () const

void	setSelected (bool sel)

void	setExpanded (bool exp)

void	setModDynamicFields (bool dyn)

void	setModStaticFields (bool sta)

	SimObject (const U8 namespaceLinkMask=LinkSuperClassName\|LinkClassName)

virtual	~SimObject ()

virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)) More...

virtual bool	onAdd ()
	Called when the object is added to the sim. More...

virtual void	onRemove ()
	Called when the object is removed from the sim. More...

virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup. More...

virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup. More...

virtual void	onNameChange (const char *name)
	Called when the object's name is changed. More...

virtual void	onStaticModified (const char slotName, const char newValue=NULL)

virtual void	inspectPreApply ()

virtual void	inspectPostApply ()

virtual void	onDeleteNotify (SimObject *object)

virtual void	onEditorEnable ()
	Called when the editor is activated. More...

virtual void	onEditorDisable ()
	Called when the editor is deactivated. More...

bool	registerObject ()

bool	registerObject (U32 id)

bool	registerObject (const char *name)

bool	registerObject (const char *name, U32 id)

void	unregisterObject ()

void	deleteObject ()

bool	addToSet (SimObjectId)

bool	addToSet (const char *)

bool	removeFromSet (SimObjectId)

bool	removeFromSet (const char *)

virtual bool	writeField (StringTableEntry fieldname, const char *value)

virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)

virtual void	writeFields (Stream &stream, U32 tabStop)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

virtual void	buildFilterList ()

void	addFieldFilter (const char *fieldName)

void	removeFieldFilter (const char *fieldName)

void	clearFieldFilters ()

bool	isFiltered (const char *fieldName)

void	assignFieldsFrom (SimObject *obj)

void	assignDynamicFieldsFrom (SimObject *obj)

Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name. More...

virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep. More...

bool	setField (const char fieldName, const char value)
	Set the value of a field. More...

virtual	~ConsoleObject ()

const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified. More...

AbstractClassRep::FieldList &	getModifiableFieldList ()

bool &	getDynamicGroupExpand ()

S32	getClassId (U32 netClassGroup) const

const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields ()

Static Public Member Functions inherited from AssetBase
static void	initPersistFields ()
	Engine. More...

Static Public Member Functions inherited from SimObject
static void	initPersistFields ()

Static Public Member Functions inherited from ConsoleObject
static const char *	lookupClassName (const U32 in_classTag)
	Get the classname from a class tag. More...

static void	initPersistFields ()

static void	consoleInit ()

static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class. More...

static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass. More...

static ConsoleObject *	create (const char *in_pClassName)

static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)

Protected Member Functions
virtual void	initializeAsset (void)

virtual void	onTamlPreWrite (void)
	Taml callbacks. More...

virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object. More...

Protected Member Functions inherited from AssetBase
virtual void	onAssetRefresh (void)

Protected Member Functions inherited from SimObject
virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object. More...

virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)

virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent. More...

virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written. More...

virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read. More...

void	linkNamespaces ()

void	unlinkNamespaces ()

Protected Member Functions inherited from ConsoleObject
	ConsoleObject ()

	ConsoleObject (const ConsoleObject &)

Static Protected Member Functions
static bool	setAudioFile (void obj, const char data)

static const char *	getAudioFile (void obj, const char data)

static bool	setVolume (void obj, const char data)

static bool	writeVolume (void *obj, StringTableEntry pFieldName)

static bool	setVolumeChannel (void obj, const char data)

static bool	writeVolumeChannel (void *obj, StringTableEntry pFieldName)

static bool	setLooping (void obj, const char data)

static bool	writeLooping (void *obj, StringTableEntry pFieldName)

static bool	setStreaming (void obj, const char data)

static bool	writeStreaming (void *obj, StringTableEntry pFieldName)

Static Protected Member Functions inherited from AssetBase
static bool	setAssetName (void obj, const char data)

static const char *	getAssetName (void obj, const char data)

static bool	writeAssetName (void *obj, StringTableEntry pFieldName)

static bool	setAssetDescription (void obj, const char data)

static const char *	getAssetDescription (void obj, const char data)

static bool	writeAssetDescription (void *obj, StringTableEntry pFieldName)

static bool	setAssetCategory (void obj, const char data)

static const char *	getAssetCategory (void obj, const char data)

static bool	writeAssetCategory (void *obj, StringTableEntry pFieldName)

static bool	setAssetAutoUnload (void obj, const char data)

static const char *	getAssetAutoUnload (void obj, const char data)

static bool	writeAssetAutoUnload (void *obj, StringTableEntry pFieldName)

static bool	setAssetInternal (void obj, const char data)

static const char *	getAssetInternal (void obj, const char data)

static bool	writeAssetInternal (void *obj, StringTableEntry pFieldName)

static const char *	getAssetPrivate (void obj, const char data)

Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)

static bool	setSuperClass (void obj, const char data)

static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)

static bool	writeInternalName (void *obj, StringTableEntry pFieldName)

static bool	setParentGroup (void obj, const char data)

static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)

static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)

static bool	writeClass (void *obj, StringTableEntry pFieldName)

static SimObject::Notify *	allocNotify ()
	Get a free Notify structure. More...

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free. More...

Static Protected Member Functions inherited from ConsoleObject
static void	addGroup (const char in_pGroupname, const char in_pGroupDocs=NULL)

static void	endGroup (const char *in_pGroupname)

static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)

static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)

static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char in_pFieldDocs)

static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char in_pFieldDocs)

static void	addFieldV (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator v, const char *in_pFieldDocs=NULL)

static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)

static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)

static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char in_pFieldDocs=NULL)

static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char in_pFieldDocs=NULL)

static void	addDepricatedField (const char *fieldName)

static bool	removeField (const char *in_pFieldname)

Additional Inherited Members
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }

Protected Types inherited from SimObject
enum	SimObjectNSLinkType { LinkClassName = BIT(0), LinkSuperClassName = BIT(1) }

Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object. More...

StringTableEntry	mIdString

Namespace *	mNameSpace

U32	mTypeMask

S32	mScriptCallbackGuard
	Whether the object is executing a script callback. More...

bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true More...

StringTableEntry	mInternalName
	Stores object Internal Name. More...

StringTableEntry	mClassName
	Stores the class name to link script class namespaces. More...

StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces. More...

U8	mNSLinkMask

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Constructor & Destructor Documentation

AudioAsset ( )

Member Function Documentation

void copyTo ( SimObject * object )

virtual

Reimplemented from AssetBase.

DECLARE_CONOBJECT ( AudioAsset )

const Audio::Description& getAudioDescription ( void ) const

inline

StringTableEntry getAudioFile ( void ) const

inline

static const char* getAudioFile	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

bool getLooping ( void ) const

inline

bool getStreaming ( void ) const

inline

F32 getVolume ( void ) const

inline

S32 getVolumeChannel ( void ) const

inline

void initializeAsset ( void )

protectedvirtual

Reimplemented from AssetBase.

void initPersistFields ( )

static

void onTamlPostWrite ( void )

protectedvirtual

Called after Taml has finished writing the object.

Reimplemented from SimObject.

void onTamlPreWrite ( void )

protectedvirtual

Taml callbacks.

Reimplemented from SimObject.

void setAudioFile ( const char * pAudioFile )

static bool setAudioFile	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

void setDescription ( const Audio::Description & audioDescription )

void setLooping ( const bool looping )

static bool setLooping	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

void setStreaming ( const bool streaming )

static bool setStreaming	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

void setVolume ( const F32 volume )

static bool setVolume	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

void setVolumeChannel ( const S32 volumeChannel )

static bool setVolumeChannel	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

static bool writeLooping	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeStreaming	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeVolume	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

static bool writeVolumeChannel	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

The documentation for this class was generated from the following files:

audio/AudioAsset.h
audio/AudioAsset.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation