SCR_ShellSoundComponent Interface Reference

Inheritance diagram for SCR_ShellSoundComponent:

Public Member Functions
override void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
override void	OnUpdateSoundJobBegin (IEntity owner)
	Called when dynamic simulation is started.
override void	OnPostInit (IEntity owner)
	Called after all components are initialized.
void	SCR_ShellSoundComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_ShellSoundComponent ()
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
ProjectileMoveComponent	m_ProjectileMoveComponent
SignalsManagerComponent	m_SignalsManagerComponent
int	m_iSignalIdxSpeed = -1
int	m_iSignalIdxSpeedVertical = -1
int	m_iSignalIdxDistanceToClosestPoint = -1
int	m_iSignalIdxCosAngleProjectileToListener = -1

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

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

~SCR_ShellSoundComponent()

void SCR_ShellSoundComponent.~SCR_ShellSoundComponent

(

)

Member Function Documentation

OnPostInit()

override void SCR_ShellSoundComponent.OnPostInit

(

IEntity

owner

)

Called after all components are initialized.

Parameters

owner

Entity this component is attached to.

Implements SimpleSoundComponent.

OnUpdateSoundJobBegin()

override void SCR_ShellSoundComponent.OnUpdateSoundJobBegin

(

IEntity

owner

)

Called when dynamic simulation is started.

Implements SimpleSoundComponent.

UpdateSoundJob()

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

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

m_iSignalIdxCosAngleProjectileToListener

int SCR_ShellSoundComponent.m_iSignalIdxCosAngleProjectileToListener = -1

protected

m_iSignalIdxDistanceToClosestPoint

int SCR_ShellSoundComponent.m_iSignalIdxDistanceToClosestPoint = -1

protected

m_iSignalIdxSpeed

int SCR_ShellSoundComponent.m_iSignalIdxSpeed = -1

protected

m_iSignalIdxSpeedVertical

int SCR_ShellSoundComponent.m_iSignalIdxSpeedVertical = -1

protected

m_ProjectileMoveComponent

ProjectileMoveComponent SCR_ShellSoundComponent.m_ProjectileMoveComponent

protected

m_SignalsManagerComponent

SignalsManagerComponent SCR_ShellSoundComponent.m_SignalsManagerComponent

protected

---

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

• Game/Components/SCR_ShellSoundComponent.c