SoundComponent Interface Reference

Inheritance diagram for SoundComponent:

Public Member Functions
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.
proto external AudioHandle	SoundEventOffset (string eventName, vector offset)
	Play a sound with a given offset from the owner entity.
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.

Additional Inherited Members
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

SoundEvent()

proto external AudioHandle SoundComponent.SoundEvent

(

string

eventName

)

Play a sound from the owner entity's position.

SoundEventBone()

proto external AudioHandle SoundComponent.SoundEventBone	(	string	eventName,
		string	bone )

Play a sound from the owner entity's position.

SoundEventOffset()

proto external AudioHandle SoundComponent.SoundEventOffset	(	string	eventName,
		vector	offset )

Play a sound with a given offset from the owner entity.

SoundEventTransform()

proto external AudioHandle SoundComponent.SoundEventTransform	(	string	eventName,
		vector	transf[] )

Play a sound from a set transformation.

---

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

• Game/generated/Components/SoundComponent.c