ScummVM API documentation
Public Member Functions | Protected Attributes | List of all members
hpl::cSoundEntityData Class Reference
Inheritance diagram for hpl::cSoundEntityData:
hpl::iResourceBase

Public Member Functions

 cSoundEntityData (tString asName)
 
bool CreateFromFile (const tString &asFile)
 
const tString & GetMainSoundName ()
 
void SetMainSoundName (const tString &asName)
 
const tString & GetStartSoundName ()
 
void SetStartSoundName (const tString &asName)
 
const tString & GetStopSoundName ()
 
void SetStopSoundName (const tString &asName)
 
void SetFadeStart (bool abX)
 
bool GetFadeStart ()
 
void SetFadeStop (bool abX)
 
bool GetFadeStop ()
 
void SetVolume (float afX)
 
float GetVolume ()
 
void SetMaxDistance (float afX)
 
float GetMaxDistance ()
 
void SetMinDistance (float afX)
 
float GetMinDistance ()
 
void SetStream (bool abX)
 
bool GetStream ()
 
void SetLoop (bool abX)
 
bool GetLoop ()
 
void SetUse3D (bool abX)
 
bool GetUse3D ()
 
void SetBlockable (bool abX)
 
bool GetBlockable ()
 
void SetBlockVolumeMul (float afX)
 
float GetBlockVolumeMul ()
 
void SetRandom (float afX)
 
float GetRandom ()
 
void SetInterval (float afX)
 
float GetInterval ()
 
void SetPriority (int alX)
 
int GetPriority ()
 
bool reload ()
 
void unload ()
 
void destroy ()
 
- Public Member Functions inherited from hpl::iResourceBase
 iResourceBase (tString asName, unsigned long alPrio)
 
tString GetName ()
 
unsigned long GetHandle ()
 
void SetHandle (unsigned long alHandle)
 
tString GetFilePath ()
 
unsigned long GetTime ()
 
unsigned long GetPrio ()
 
unsigned long GetSize ()
 
void SetLogDestruction (bool abX)
 
unsigned int GetUserCount ()
 
void IncUserCount ()
 
void DecUserCount ()
 
bool HasUsers ()
 

Protected Attributes

tString msMainSound
 
tString msStartSound
 
tString msStopSound
 
bool mbFadeStart
 
bool mbFadeStop
 
float mfVolume
 
float mfMaxDistance
 
float mfMinDistance
 
bool mbStream
 
bool mbLoop
 
bool mbUse3D
 
bool mbBlockable
 
float mfBlockVolumeMul
 
float mfRandom
 
float mfInterval
 
int mlPriority
 
- Protected Attributes inherited from hpl::iResourceBase
unsigned int mlPrio
 
unsigned long mlTime
 
unsigned long mlSize
 
unsigned int mlUserCount
 
unsigned long mlHandle
 
tString msName
 
tString msFilePath
 
bool mbLogDestruction
 

Additional Inherited Members

- Static Public Member Functions inherited from hpl::iResourceBase
static bool GetLogCreateAndDelete ()
 
static void SetLogCreateAndDelete (bool abX)
 
- Static Protected Attributes inherited from hpl::iResourceBase
static bool mbLogCreateAndDelete
 

Member Function Documentation

◆ reload()

bool hpl::cSoundEntityData::reload ( )
inlinevirtual

virtual bool Reload()=0;

Returns
true is reload was successful, else false.

Implements hpl::iResourceBase.

◆ unload()

void hpl::cSoundEntityData::unload ( )
inlinevirtual

Free most the memory, save info to get started again.

Implements hpl::iResourceBase.

◆ destroy()

void hpl::cSoundEntityData::destroy ( )
inlinevirtual

Free all memory.

Implements hpl::iResourceBase.

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