VehicleControllerComponent.c File Reference

Go to the source code of this file.

Classes
class	VehicleControllerComponentClass

Functions
ScriptInvokerVoid	GetOnEngineStart ()
	Invoker for the Engine Started event.
ScriptInvokerVoid	GetOnEngineStop ()
	Invoker for the Engine Stopped event.
SCR_VehicleDamageManagerComponent	GetDamageManager ()
bool	IsStarterFunctional ()
	Return if engine starter is functional.
void	OnDestroyed (IEntity ent)
void	OnCompartmentEntered (IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID)
void	OnCompartmentLeft (IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID)
override void	OnPostInit (IEntity owner)
	Editable Mine.
override void	OnDelete (IEntity owner)
override void	OnEngineStartBegin ()
	Gets called when the engine start routine begins (animation event).
override void	OnEngineStartProgress ()
	Get called while engine starter is active.
override void	OnEngineStartInterrupt ()
	Gets called when the engine start routine was interrupted.
override void	OnEngineStartSuccess ()
	Gets called when the engine start routine has successfully completed.
override void	OnEngineStartFail (EVehicleEngineStartFailedReason reason)
	Gets called when the engine start routine has failed.
override bool	OnBeforeEngineStart ()
override void	OnEngineStart ()
	Is called every time the engine starts.
override void	OnEngineStop ()
	Is called every time the engine stops.
override bool	ValidateCanMove ()

Variables
VehicleControllerComponentClass	m_OnEngineStart
VehicleControllerComponentClass	m_OnEngineStop
int	m_iOccupants
SCR_VehicleDamageManagerComponent	m_DamageManager
	needed to check if engine start is even possible
SCR_PowerComponent	m_PowerComponent
bool	m_bIsStarting
AudioHandle	m_iEngineStarterHandle = AudioHandle.Invalid
AudioHandle	m_iEngineStartHandle = AudioHandle.Invalid
AudioHandle	m_iEngineStopHandle = AudioHandle.Invalid

Function Documentation

GetDamageManager()

SCR_VehicleDamageManagerComponent GetDamageManager ( )

protected

Definition at line 44 of file VehicleControllerComponent.c.

GetOnEngineStart()

ScriptInvokerVoid GetOnEngineStart ( )

protected

Invoker for the Engine Started event.

Definition at line 25 of file VehicleControllerComponent.c.

GetOnEngineStop()

ScriptInvokerVoid GetOnEngineStop ( )

protected

Invoker for the Engine Stopped event.

Definition at line 35 of file VehicleControllerComponent.c.

IsStarterFunctional()

bool IsStarterFunctional ( )

protected

Return if engine starter is functional.

Definition at line 51 of file VehicleControllerComponent.c.

OnBeforeEngineStart()

override bool OnBeforeEngineStart ( )

protected

Is called every time the controller wants to start the engine.

Returns

true if the engine can start, false otherwise.

Definition at line 229 of file VehicleControllerComponent.c.

OnCompartmentEntered()

void OnCompartmentEntered ( IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID )

protected

Definition at line 72 of file VehicleControllerComponent.c.

OnCompartmentLeft()

void OnCompartmentLeft ( IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID )

protected

Definition at line 83 of file VehicleControllerComponent.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 109 of file VehicleControllerComponent.c.

OnDestroyed()

void OnDestroyed ( IEntity ent )

protected

Definition at line 64 of file VehicleControllerComponent.c.

OnEngineStart()

override void OnEngineStart ( )

protected

Is called every time the engine starts.

Definition at line 240 of file VehicleControllerComponent.c.

OnEngineStartBegin()

override void OnEngineStartBegin ( )

protected

Gets called when the engine start routine begins (animation event).

Definition at line 122 of file VehicleControllerComponent.c.

OnEngineStartFail()

override void OnEngineStartFail ( EVehicleEngineStartFailedReason reason )

protected

Gets called when the engine start routine has failed.

Definition at line 197 of file VehicleControllerComponent.c.

OnEngineStartInterrupt()

override void OnEngineStartInterrupt ( )

protected

Gets called when the engine start routine was interrupted.

Definition at line 161 of file VehicleControllerComponent.c.

OnEngineStartProgress()

override void OnEngineStartProgress ( )

protected

Get called while engine starter is active.

Definition at line 148 of file VehicleControllerComponent.c.

OnEngineStartSuccess()

override void OnEngineStartSuccess ( )

protected

Gets called when the engine start routine has successfully completed.

Definition at line 181 of file VehicleControllerComponent.c.

OnEngineStop()

override void OnEngineStop ( )

protected

Is called every time the engine stops.

Definition at line 256 of file VehicleControllerComponent.c.

ValidateCanMove()

override bool ValidateCanMove ( )

protected

Definition at line 282 of file VehicleControllerComponent.c.

Variable Documentation

m_bIsStarting

bool m_bIsStarting

protected

Definition at line 16 of file VehicleControllerComponent.c.

m_DamageManager

SCR_VehicleDamageManagerComponent m_DamageManager

protected

needed to check if engine start is even possible

Definition at line 14 of file VehicleControllerComponent.c.

m_iEngineStarterHandle

AudioHandle m_iEngineStarterHandle = AudioHandle.Invalid

protected

Definition at line 19 of file VehicleControllerComponent.c.

m_iEngineStartHandle

AudioHandle m_iEngineStartHandle = AudioHandle.Invalid

protected

Definition at line 20 of file VehicleControllerComponent.c.

m_iEngineStopHandle

AudioHandle m_iEngineStopHandle = AudioHandle.Invalid

protected

Definition at line 21 of file VehicleControllerComponent.c.

m_iOccupants

int m_iOccupants

protected

Definition at line 11 of file VehicleControllerComponent.c.

m_OnEngineStart

VehicleControllerComponentClass m_OnEngineStart

Class responsible for base game vehicle.

m_OnEngineStop

VehicleControllerComponentClass m_OnEngineStop

m_PowerComponent

SCR_PowerComponent m_PowerComponent

protected

Definition at line 15 of file VehicleControllerComponent.c.