SCR_HelicopterSoundComponent Interface Reference

Inheritance diagram for SCR_HelicopterSoundComponent:

Public Member Functions
override void	UpdateSoundJob (IEntity owner, float timeSlice)
	Call when component is in range.
override void	OnPostInit (IEntity owner)
override void	OnInit (IEntity owner)
void	~SCR_HelicopterSoundComponent ()
Public Member Functions inherited from SCR_VehicleSoundComponent
void	SCR_VehicleSoundComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_VehicleSoundComponent ()
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	CalculateSpeedToCameraSignal (IEntity owner)
	Updates SpeedToCamera signal based on owner velocity towards the camera.
void	HandleWashRotor (IEntity owner)
	Handles wash rotor sound.
void	RegisterOnDamageChanged ()
void	UnregisterOnDamageChanged ()
void	OnDamageStateChanged (EDamageState state)
void	RegisterRotorMainOnDamageChanged ()
void	UnregisterRotorMainOnDamageChanged ()
void	RotorMainOnStateChanged ()
Protected Member Functions inherited from SCR_VehicleSoundComponent
array< ref SCR_HitZoneStateSignalData >	GetHitZoneStateSignalData ()
void	RegisterHitZoneSignals (IEntity owner)
void	UnregisterHitZoneSignals ()
Protected Member Functions inherited from SimpleSoundComponent
void	OnFrame (IEntity owner, float timeSlice)
void	OnUpdateSoundJobBegin (IEntity owner)
void	OnUpdateSoundJobEnd (IEntity owner)

Protected Attributes
int	m_iDistanceSignalIdx
int	m_iSpeedToCameraSignalIdx
int	m_AltitudeAGLSignalIdx
int	m_MainRotorRPMScaledIdx
SignalsManagerComponent	m_SignalsManagerComponent
float	m_fTimer
AudioHandle	m_WashRotorAudioHandle = AudioHandle.Invalid
	Wash rotor audio handle.
SCR_HelicopterDamageManagerComponent	m_HelicopterDamageManagerComponent
	Damage state signal.
SCR_HitZone	m_RotorMainHitZone
	Main rotor damage state.
EDamageState	m_eRotorMainDamageState
Protected Attributes inherited from SCR_VehicleSoundComponent
ref array< ref SCR_HitZoneStateSignal >	m_aHitZoneStateSignal = {}

Static Protected Attributes
const string	SPEED_TO_CAMERA_SIGNAL_NAME = "SpeedToCamera"
const string	DISTANCE_SIGNAL_NAME = "Distance"
const string	ALTITUDE_AGL = "AltitudeAGL"
const string	MAIN_ROTOR_RPM_SCALED = "MainRotorRPMScaled"
const string	MAIN_ROTOR_HIT_ZONE_NAME = "RotorMain"
const string	DAMAGE_STATE_SIGNAL_NAME = "DamageState"
const string	ROTOR_MAIN_DAMAGE_STATE_SIGNAL_NAME = "RotorMainDamageState"
const float	UPDATE_TIME = 0.15
const float	WASH_ROTOR_DISTANCE_LIMIT = 100
const float	ALTITUDE_LIMIT = 50
const float	MAIN_ROTOR_RPM_SCALED_THRESHOLD = 0.2

Constructor & Destructor Documentation

~SCR_HelicopterSoundComponent()

void SCR_HelicopterSoundComponent.~SCR_HelicopterSoundComponent

(

)

Member Function Documentation

CalculateSpeedToCameraSignal()

void SCR_HelicopterSoundComponent.CalculateSpeedToCameraSignal ( IEntity owner )

protected

Updates SpeedToCamera signal based on owner velocity towards the camera.

Parameters

owner

owner entity - cannot be null

HandleWashRotor()

void SCR_HelicopterSoundComponent.HandleWashRotor ( IEntity owner )

protected

Handles wash rotor sound.

Triggers the sound, when conditions are met and updates sounds position based on owner's altitude.

Parameters

[in]

owner

cannot be null

OnDamageStateChanged()

void SCR_HelicopterSoundComponent.OnDamageStateChanged ( EDamageState state )

protected

OnInit()

override void SCR_HelicopterSoundComponent.OnInit

(

IEntity

owner

)

Implements SCR_VehicleSoundComponent.

OnPostInit()

override void SCR_HelicopterSoundComponent.OnPostInit

(

IEntity

owner

)

RegisterOnDamageChanged()

void SCR_HelicopterSoundComponent.RegisterOnDamageChanged ( )

protected

RegisterRotorMainOnDamageChanged()

void SCR_HelicopterSoundComponent.RegisterRotorMainOnDamageChanged ( )

protected

RotorMainOnStateChanged()

void SCR_HelicopterSoundComponent.RotorMainOnStateChanged ( )

protected

UnregisterOnDamageChanged()

void SCR_HelicopterSoundComponent.UnregisterOnDamageChanged ( )

protected

UnregisterRotorMainOnDamageChanged()

void SCR_HelicopterSoundComponent.UnregisterRotorMainOnDamageChanged ( )

protected

UpdateSoundJob()

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

Call when component is in range.

Implements SimpleSoundComponent.

Member Data Documentation

ALTITUDE_AGL

const string SCR_HelicopterSoundComponent.ALTITUDE_AGL = "AltitudeAGL"

staticprotected

ALTITUDE_LIMIT

const float SCR_HelicopterSoundComponent.ALTITUDE_LIMIT = 50

staticprotected

DAMAGE_STATE_SIGNAL_NAME

const string SCR_HelicopterSoundComponent.DAMAGE_STATE_SIGNAL_NAME = "DamageState"

staticprotected

DISTANCE_SIGNAL_NAME

const string SCR_HelicopterSoundComponent.DISTANCE_SIGNAL_NAME = "Distance"

staticprotected

m_AltitudeAGLSignalIdx

int SCR_HelicopterSoundComponent.m_AltitudeAGLSignalIdx

protected

m_eRotorMainDamageState

EDamageState SCR_HelicopterSoundComponent.m_eRotorMainDamageState

protected

m_fTimer

float SCR_HelicopterSoundComponent.m_fTimer

protected

m_HelicopterDamageManagerComponent

SCR_HelicopterDamageManagerComponent SCR_HelicopterSoundComponent.m_HelicopterDamageManagerComponent

protected

Damage state signal.

m_iDistanceSignalIdx

int SCR_HelicopterSoundComponent.m_iDistanceSignalIdx

protected

m_iSpeedToCameraSignalIdx

int SCR_HelicopterSoundComponent.m_iSpeedToCameraSignalIdx

protected

m_MainRotorRPMScaledIdx

int SCR_HelicopterSoundComponent.m_MainRotorRPMScaledIdx

protected

m_RotorMainHitZone

SCR_HitZone SCR_HelicopterSoundComponent.m_RotorMainHitZone

protected

Main rotor damage state.

m_SignalsManagerComponent

SignalsManagerComponent SCR_HelicopterSoundComponent.m_SignalsManagerComponent

protected

m_WashRotorAudioHandle

AudioHandle SCR_HelicopterSoundComponent.m_WashRotorAudioHandle = AudioHandle.Invalid

protected

Wash rotor audio handle.

MAIN_ROTOR_HIT_ZONE_NAME

const string SCR_HelicopterSoundComponent.MAIN_ROTOR_HIT_ZONE_NAME = "RotorMain"

staticprotected

MAIN_ROTOR_RPM_SCALED

const string SCR_HelicopterSoundComponent.MAIN_ROTOR_RPM_SCALED = "MainRotorRPMScaled"

staticprotected

MAIN_ROTOR_RPM_SCALED_THRESHOLD

const float SCR_HelicopterSoundComponent.MAIN_ROTOR_RPM_SCALED_THRESHOLD = 0.2

staticprotected

ROTOR_MAIN_DAMAGE_STATE_SIGNAL_NAME

const string SCR_HelicopterSoundComponent.ROTOR_MAIN_DAMAGE_STATE_SIGNAL_NAME = "RotorMainDamageState"

staticprotected

SPEED_TO_CAMERA_SIGNAL_NAME

const string SCR_HelicopterSoundComponent.SPEED_TO_CAMERA_SIGNAL_NAME = "SpeedToCamera"

staticprotected

UPDATE_TIME

const float SCR_HelicopterSoundComponent.UPDATE_TIME = 0.15

staticprotected

WASH_ROTOR_DISTANCE_LIMIT

const float SCR_HelicopterSoundComponent.WASH_ROTOR_DISTANCE_LIMIT = 100

staticprotected

---

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

• Game/Components/VehicleSoundComponent/SCR_HelicopterSoundComponent.c