SCR_CharacterSoundComponent Interface Reference

Inheritance diagram for SCR_CharacterSoundComponent:

Public Member Functions
override void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
vector	GetBonePosVector (IEntity owner, int index, int boneIdx)
override void	OnPostInit (IEntity owner)
	Called after all components are initialized.
SCR_CharacterSoundComponentClass	GetComponentData ()
void	SCR_CharacterSoundComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
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.
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.
proto external IEntity	GetOwner ()

Protected Attributes
SignalsManagerComponent	m_SignalsManagerComponent
ref array< int >	m_aSignalIdx
ref array< int >	m_aTrackedBoneIdx
ref array< int >	m_aPivotBoneIdx
ref array< vector >	m_aBonePositionLast

Additional Inherited Members
Protected Member Functions inherited from SimpleSoundComponent
void	OnPostInit (IEntity owner)
	Called after all components are initialized.
void	OnInit (IEntity owner)
	Called during EOnInit.
void	OnFrame (IEntity owner, float timeSlice)
	Called during EOnFrame.
void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
void	OnUpdateSoundJobBegin (IEntity owner)
	Called when dynamic simulation is started.
void	OnUpdateSoundJobEnd (IEntity owner)
	Called when dynamic simulation is stopped.

Constructor & Destructor Documentation

SCR_CharacterSoundComponent()

void SCR_CharacterSoundComponent.SCR_CharacterSoundComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Member Function Documentation

GetBonePosVector()

vector SCR_CharacterSoundComponent.GetBonePosVector	(	IEntity	owner,
		int	index,
		int	boneIdx
	)

GetComponentData()

SCR_CharacterSoundComponentClass SCR_CharacterSoundComponent.GetComponentData

(

)

OnPostInit()

override void SCR_CharacterSoundComponent.OnPostInit

(

IEntity

owner

)

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implements SimpleSoundComponent.

UpdateSoundJob()

override void SCR_CharacterSoundComponent.UpdateSoundJob	(	IEntity	owner,
		float	timeSlice
	)

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

m_aBonePositionLast

ref array<vector> SCR_CharacterSoundComponent.m_aBonePositionLast

protected

m_aPivotBoneIdx

ref array<int> SCR_CharacterSoundComponent.m_aPivotBoneIdx

protected

m_aSignalIdx

ref array<int> SCR_CharacterSoundComponent.m_aSignalIdx

protected

m_aTrackedBoneIdx

ref array<int> SCR_CharacterSoundComponent.m_aTrackedBoneIdx

protected

m_SignalsManagerComponent

SignalsManagerComponent SCR_CharacterSoundComponent.m_SignalsManagerComponent

protected

---

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

• Game/Components/SCR_CharacterSoundComponent.c