Torque Game Engine Documentation CVS Revision Label 1.3.x

Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

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. static void  consoleInit ()   Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject. Data Fields AudioDescription *  mDescriptionObject AudioSampleEnvironment *  mSampleEnvironment StringTableEntry  mFilename bool  mPreload Private Types typedef SimDataBlock  Parent Private Attributes Resource< AudioBuffer >  mBuffer Member Typedef Documentation typedef SimDataBlock AudioProfile::Parent [private]   Reimplemented from SimDataBlock. Constructor & Destructor Documentation AudioProfile::AudioProfile (   )  Member Function Documentation AudioProfile::DECLARE_CONOBJECT (  AudioProfile   )  static void AudioProfile::initPersistFields (   )  [static]   Register dynamic fields in a subclass of ConsoleObject. See also: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup() Reimplemented from SimObject. static void AudioProfile::consoleInit (   )  [static]   Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject. Deprecated: You should use ConsoleMethod and ConsoleFunction, not this, to register methods or commands. See also: console Reimplemented from ConsoleObject. 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. Returns: True if all went well; false if something failed. See also: preload() and File Downloading Reimplemented from SimDataBlock. const Audio::Description* AudioProfile::getDescription (   )  const [inline] bool AudioProfile::isPreload (   )  [inline] Field Documentation Resource<AudioBuffer> AudioProfile::mBuffer [private] AudioDescription* AudioProfile::mDescriptionObject AudioSampleEnvironment* AudioProfile::mSampleEnvironment StringTableEntry AudioProfile::mFilename bool AudioProfile::mPreload

---

All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen