#include <plDirectMusicSound.h>
Inheritance diagram for plDirectMusicSound:
Public Member Functions | |
| plDirectMusicSound () | |
| virtual void | read (hsStream *S, plResManager *mgr) |
| virtual void | write (hsStream *S, plResManager *mgr) |
 Public Member Functions inherited from plSound | |
| plSound () | |
| unsigned char | getType () const |
| unsigned char | getPriority () const |
| bool | isPlaying () const |
| double | getTime () const |
| int | getMaxFalloff () const |
| int | getMinFalloff () const |
| int | getOuterVol () const |
| int | getInnerCone () const |
| int | getOuterCone () const |
| float | getCurrVolume () const |
| float | getDesiredVolume () const |
| float | getFadedVolume () const |
| unsigned int | getProperties () const |
| plKey | getSoftRegion () const |
| plKey | getSoftOcclusionRegion () const |
| plKey | getDataBuffer () const |
| plString | getSubtitleId () const |
| void | setType (unsigned char type) |
| void | setPriority (unsigned char priority) |
| void | setPlaying (bool playing) |
| void | setTime (double time) |
| void | setFalloff (int min, int max) |
| void | setOuterVol (int vol) |
| void | setCone (int inner, int outer) |
| void | setCurrVolume (float vol) |
| void | setDesiredVolume (float vol) |
| void | setFadedVolume (float vol) |
| void | setProperties (unsigned int props) |
| void | setSoftRegion (plKey region) |
| void | setSoftOcclusionRegion (plKey region) |
| void | setDataBuffer (plKey buffer) |
| void | setSubtitleId (const plString &subtitle) |
| const plEAXSourceSettings & | getEAXSettings () const |
| const plFadeParams & | getFadeInParams () const |
| const plFadeParams & | getFadeOutParams () const |
| plEAXSourceSettings & | getEAXSettings () |
| plFadeParams & | getFadeInParams () |
| plFadeParams & | getFadeOutParams () |
| Public Member Functions inherited from plSynchedObject | |
| plSynchedObject () | |
| int | getFlags () const |
| void | setFlags (int flags) |
| const std::vector< plString > & | getExcludes () const |
| const std::vector< plString > & | getVolatiles () const |
| void | setExclude (const plString &sdl) |
| void | setVolatile (const plString &sdl) |
| void | clearExcludes () |
| void | clearVolatiles () |
| Public Member Functions inherited from hsKeyedObject | |
| void | init (const plString &name) |
| plKey | getKey () const |
| void | setKey (plKey key) |
| Public Member Functions inherited from plCreatable | |
| plCreatable () | |
| virtual | ~plCreatable () |
| virtual short | ClassIndex () const =0 |
| short | ClassIndex (PlasmaVer ver) const |
| virtual const char * | ClassName () const |
| virtual bool | ClassInstance (short) const |
| virtual bool | isStub () const |
| virtual void | prcWrite (pfPrcHelper *prc) |
| virtual void | prcParse (const pfPrcTag *tag, plResManager *mgr) |
Protected Member Functions | |
| virtual void | IPrcWrite (pfPrcHelper *prc) |
| virtual void | IPrcParse (const pfPrcTag *tag, plResManager *mgr) |
| Protected Member Functions inherited from plSound | |
| virtual void | IRead (hsStream *S, plResManager *mgr) |
| virtual void | IWrite (hsStream *S, plResManager *mgr) |
Protected Attributes | |
| unsigned int | fUnknown1 |
| plString | fFileName |
| Protected Attributes inherited from plSound | |
| unsigned char | fType |
| unsigned char | fPriority |
| bool | fPlaying |
| double | fTime |
| int | fMaxFalloff |
| int | fMinFalloff |
| int | fOuterVol |
| int | fInnerCone |
| int | fOuterCone |
| float | fCurrVolume |
| float | fDesiredVol |
| float | fFadedVolume |
| unsigned int | fProperties |
| plEAXSourceSettings | fEAXSettings |
| plFadeParams | fFadeInParams |
| plFadeParams | fFadeOutParams |
| plKey | fSoftRegion |
| plKey | fSoftOcclusionRegion |
| plKey | fDataBuffer |
| plString | fSubtitleId |
| Protected Attributes inherited from plSynchedObject | |
| unsigned int | fSynchFlags |
| std::vector< plString > | fSDLExcludeList |
| std::vector< plString > | fSDLVolatileList |
Additional Inherited Members | |
| Public Types inherited from plSound | |
| enum | Property { kPropIs3DSound = 0x1, kPropDisableLOD = 0x2, kPropLooping = 0x4, kPropAutoStart = 0x8, kPropLocalOnly = 0x10, kPropLoadOnlyOnCall = 0x20, kPropFullyDisabled = 0x40, kPropDontFade = 0x80, kPropIncidental = 0x100 } |
| enum | Type { kStartType = 0, kSoundFX = kStartType, kAmbience, kBackgroundMusic, kGUISound, kNPCVoices, kNumTypes } |
| enum | StreamType { kNoStream, kStreamFromRAM, kStreamFromDisk, kStreamCompressed } |
Constructor & Destructor Documentation
| plDirectMusicSound::plDirectMusicSound | ( | ) |
Member Function Documentation
|
protectedvirtual |
This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.
Reimplemented from plSound.
|
protectedvirtual |
This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().
Reimplemented from plSound.
|
virtual |
Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.
Reimplemented from plSound.
|
virtual |
Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.
Reimplemented from plSound.
Member Data Documentation
|
protected |
|
protected |
The documentation for this class was generated from the following file:
- core/PRP/Audio/plDirectMusicSound.h
