CCmpSoundManager Class Reference

Inheritance diagram for CCmpSoundManager:

Collaboration diagram for CCmpSoundManager:

Public Member Functions
int	GetComponentTypeId () const override
void	Init (const CParamNode &paramNode) override
void	Deinit () override
void	Serialize (ISerializer &serialize) override
void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize) override
void	PlaySoundGroup (const std::wstring &name, entity_id_t source) override
	Start playing audio defined by a sound group file. More...
void	PlaySoundGroupAtPosition (const std::wstring &name, const CFixedVector3D &sourcePos) override
	Start playing audio defined by a sound group file. More...
void	PlaySoundGroupForPlayer (const VfsPath &groupPath, const player_id_t playerId) const override
	Start playing audio defined by a sound group file for a player. More...
void	StopMusic () override
virtual void	PlaySoundGroup (const std::wstring &name, entity_id_t source)=0
	Start playing audio defined by a sound group file. More...
virtual void	PlaySoundGroupAtPosition (const std::wstring &name, const CFixedVector3D &sourcePos)=0
	Start playing audio defined by a sound group file. More...
virtual void	PlaySoundGroupForPlayer (const VfsPath &groupPath, const player_id_t playerId) const =0
	Start playing audio defined by a sound group file for a player. More...
virtual void	StopMusic ()=0
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 CSimContext &	GetSimContext () const
void	SetSimContext (const CSimContext &context)
virtual void	Serialize (ISerializer &serialize)=0
virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)=0
virtual bool	NewJSObject (const 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
virtual int	GetComponentTypeId () const =0

Static Public Member Functions
static void	ClassInit (CComponentManager &componentManager)
static IComponent *	Allocate (const ScriptInterface &, JS::HandleValue)
static void	Deallocate (IComponent *cmp)
static std::string	GetSchema ()
Static Public Member Functions inherited from IComponent
static std::string	GetSchema ()
static void	RegisterComponentType (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
static void	RegisterComponentTypeScriptWrapper (CComponentManager &mgr, EInterfaceId iid, EComponentTypeId cid, AllocFunc alloc, DeallocFunc dealloc, const char *name, const std::string &schema)
static u8	GetSerializationVersion ()

Additional Inherited Members
Public Types inherited from IComponent
using	AllocFunc = IComponent *(*)(const ScriptInterface &scriptInterface, JS::HandleValue ctor)
using	DeallocFunc = void(*)(IComponent *)

Member Function Documentation

Allocate()

static IComponent * CCmpSoundManager::Allocate ( const ScriptInterface &  , JS::HandleValue    )

inlinestatic

ClassInit()

static void CCmpSoundManager::ClassInit ( CComponentManager &  componentManager )

inlinestatic

Deallocate()

static void CCmpSoundManager::Deallocate ( IComponent *  cmp )

inlinestatic

Deinit()

void CCmpSoundManager::Deinit ( )

inlineoverridevirtual

Implements IComponent.

Deserialize()

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

inlineoverridevirtual

Implements IComponent.

GetComponentTypeId()

int CCmpSoundManager::GetComponentTypeId ( ) const

inlineoverridevirtual

Implements IComponent.

GetSchema()

static std::string CCmpSoundManager::GetSchema ( )

inlinestatic

Init()

void CCmpSoundManager::Init ( const CParamNode &  paramNode )

inlineoverridevirtual

Implements IComponent.

PlaySoundGroup()

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

inlineoverridevirtual

Start playing audio defined by a sound group file.

Parameters

name	VFS path of sound group .xml, relative to audio/.
source	entity emitting the sound (used for positioning).

Implements ICmpSoundManager.

PlaySoundGroupAtPosition()

void CCmpSoundManager::PlaySoundGroupAtPosition ( const std::wstring &  name, const CFixedVector3D &  sourcePos  )

inlineoverridevirtual

Start playing audio defined by a sound group file.

Parameters

name	VFS path of sound group .xml, relative to audio/.
sourcePos	3d position of the sound emitter.

Implements ICmpSoundManager.

PlaySoundGroupForPlayer()

void CCmpSoundManager::PlaySoundGroupForPlayer ( const VfsPath &  groupPath, const player_id_t  playerId  ) const

inlineoverridevirtual

Start playing audio defined by a sound group file for a player.

Parameters

name	VFS path of sound group .xml, relative to audio/.
player	the player entity.

Implements ICmpSoundManager.

Serialize()

void CCmpSoundManager::Serialize ( ISerializer &  serialize )

inlineoverridevirtual

Implements IComponent.

StopMusic()

void CCmpSoundManager::StopMusic ( )

inlineoverridevirtual

Implements ICmpSoundManager.

---

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

• /home/docker/jenkins/workspace/technical-docs/source/simulation2/components/CCmpSoundManager.cpp