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

Inheritance diagram for ICmpSoundManager:

Collaboration diagram for ICmpSoundManager:

[legend]

Public Member Functions
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

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

using	DeallocFunc = void()(IComponent )

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 ()

Detailed Description

Interface to the engine's sound system.

Member Function Documentation

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

pure virtual

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).

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

pure virtual

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.

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

pure virtual

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.

virtual void ICmpSoundManager::StopMusic ( )

pure virtual

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

/home/docker/jenkins/workspace/technical-docs/source/simulation2/components/ICmpSoundManager.h