CommunicationSoundComponent Interface Reference

Inheritance diagram for CommunicationSoundComponent:

Public Member Functions
proto external void	GetMetadata (AudioHandle handle, out notnull array< string > metadata)
	Get list of metadata. Last item in array is 'textFormat'.
proto external void	SoundEventPriority (string eventName, int priority, bool ignoreQueue=false)
	Add a soundevent with priority to the priority queue which will be played in order of priority.
void	OnSoundEventFinished (string eventName, AudioHandle handle, int priority, bool terminated)
void	OnSoundEventStarted (string eventName, AudioHandle handle, int priority)
Public Member Functions inherited from SoundComponent
proto external AudioHandle	SoundEvent (string eventName)
	Play a sound from the owner entity's position.
proto external AudioHandle	SoundEventTransform (string eventName, vector transf[])
	Play a sound from a set transformation.
proto external AudioHandle	SoundEventBone (string eventName, string bone)
	Play a sound from the owner entity's position If boneName is different than string.Empty, then you might need to first use SetTransformation(vector transf[]) or else sound may fail the auditability test.
proto external AudioHandle	SoundEventOffset (string eventName, vector offset)
	Play a sound with a given offset from the owner entity If offset is different than vector.Zero, then you might need to first use SetTransformation(vector transf[]) or else sound may fail the auditability test.
Public Member Functions inherited from SimpleSoundComponent
proto external void	EnableDynamicSimulation (bool value)
	Enables the dynamic simulation.
proto external void	SetScriptedMethodsCall (bool state)
	Set flag for script callbacks.
proto external bool	IsScriptedMethodsCallEnabled ()
	TRUE when flag for script callbacks is set.

Protected Member Functions
void	HandleMetadata (array< string > metadata, int priority, float distance)
Protected Member Functions inherited from SimpleSoundComponent
void	OnFrame (IEntity owner, float timeSlice)
void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
void	OnUpdateSoundJobBegin (IEntity owner)
void	OnUpdateSoundJobEnd (IEntity owner)

Member Function Documentation

GetMetadata()

proto external void CommunicationSoundComponent.GetMetadata	(	AudioHandle	handle,
		out notnull array< string >	metadata )

Get list of metadata. Last item in array is 'textFormat'.

HandleMetadata()

void CommunicationSoundComponent.HandleMetadata ( array< string > metadata, int priority, float distance )

protected

Implemented in SCR_CommunicationSoundComponent.

OnSoundEventFinished()

void CommunicationSoundComponent.OnSoundEventFinished	(	string	eventName,
		AudioHandle	handle,
		int	priority,
		bool	terminated )

Implemented in SCR_CommunicationSoundComponent.

OnSoundEventStarted()

void CommunicationSoundComponent.OnSoundEventStarted	(	string	eventName,
		AudioHandle	handle,
		int	priority )

Implemented in SCR_CommunicationSoundComponent.

SoundEventPriority()

proto external void CommunicationSoundComponent.SoundEventPriority	(	string	eventName,
		int	priority,
		bool	ignoreQueue = false )

Add a soundevent with priority to the priority queue which will be played in order of priority.

---

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

• Game/generated/Components/CommunicationSoundComponent.c