Pyrogenesis  trunk
Public Member Functions | Static Public Member Functions | List of all members
CCmpSoundManager Class Reference
Inheritance diagram for CCmpSoundManager:
Inheritance graph
[legend]
Collaboration diagram for CCmpSoundManager:
Collaboration graph
[legend]

Public Member Functions

virtual int GetComponentTypeId () const
 
virtual void Init (const CParamNode &paramNode)
 
virtual void Deinit ()
 
virtual void Serialize (ISerializer &serialize)
 
virtual void Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)
 
virtual void PlaySoundGroup (const std::wstring &name, entity_id_t source)
 Start playing audio defined by a sound group file. More...
 
virtual void StopMusic ()
 
- Public Member Functions inherited from IComponent
virtual ~IComponent ()
 
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 bool NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
 Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...
 
virtual JS::Value GetJSInstance () const
 

Static Public Member Functions

static void ClassInit (CComponentManager &componentManager)
 
static IComponentAllocate (ScriptInterface &, JS::HandleValue)
 
static void Deallocate (IComponent *cmp)
 
static std::string GetSchema ()
 
- Static Public Member Functions inherited from IComponent
static std::string GetSchema ()
 
static u8 GetSerializationVersion ()
 

Member Function Documentation

static IComponent* CCmpSoundManager::Allocate ( ScriptInterface ,
JS::HandleValue   
)
inlinestatic
static void CCmpSoundManager::ClassInit ( CComponentManager componentManager)
inlinestatic
static void CCmpSoundManager::Deallocate ( IComponent cmp)
inlinestatic
virtual void CCmpSoundManager::Deinit ( )
inlinevirtual

Implements IComponent.

virtual void CCmpSoundManager::Deserialize ( const CParamNode paramNode,
IDeserializer deserialize 
)
inlinevirtual

Implements IComponent.

virtual int CCmpSoundManager::GetComponentTypeId ( ) const
inlinevirtual

Implements IComponent.

static std::string CCmpSoundManager::GetSchema ( )
inlinestatic
virtual void CCmpSoundManager::Init ( const CParamNode paramNode)
inlinevirtual

Implements IComponent.

virtual void CCmpSoundManager::PlaySoundGroup ( const std::wstring &  name,
entity_id_t  source 
)
inlinevirtual

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)

Implements ICmpSoundManager.

virtual void CCmpSoundManager::Serialize ( ISerializer serialize)
inlinevirtual

Implements IComponent.

virtual void CCmpSoundManager::StopMusic ( )
inlinevirtual

Implements ICmpSoundManager.


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