Pyrogenesis  13997
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
ICmpSoundManager Class Referenceabstract

Interface to the engine's sound system. More...

#include <ICmpSoundManager.h>

Inheritance diagram for ICmpSoundManager:
IComponent CCmpSoundManager

Public Member Functions

virtual void PlaySoundGroup (std::wstring name, entity_id_t source)=0
 Start playing audio defined by a sound group file. More...
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
virtual void Init (const CParamNode &paramNode)=0
 
virtual void Deinit ()=0
 
virtual void HandleMessage (const CMessage &msg, bool global)
 
CEntityHandle GetEntityHandle () const
 
void SetEntityHandle (CEntityHandle ent)
 
entity_id_t GetEntityId () const
 
CEntityHandle GetSystemEntity () const
 
const CSimContextGetSimContext () const
 
void SetSimContext (const CSimContext &context)
 
virtual void Serialize (ISerializer &serialize)=0
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
 
virtual JSClass * GetJSClass () const
 
virtual jsval GetJSInstance () const
 

Additional Inherited Members

- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Detailed Description

Interface to the engine's sound system.

Definition at line 26 of file ICmpSoundManager.h.

Member Function Documentation

virtual void ICmpSoundManager::PlaySoundGroup ( std::wstring  name,
entity_id_t  source 
)
pure virtual

Start playing audio defined by a sound group file.

Parameters
nameVFS path of sound group .xml, relative to audio/
sourceentity emitting the sound (used for positioning)

Implemented in CCmpSoundManager.


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