Inheritance diagram for BaseVehicleControllerComponent:

Public Member Functions
proto external VehicleBaseSimulation	GetBaseSimulation ()
	Returns the base of simulation component associated with this controller.

proto external FuelManagerComponent	GetFuelManager ()
	Returns the fuel manager associated with this controller.

proto external BaseLightManagerComponent	GetLightManager ()
	Returns the light manager associated with this controller.

proto external PilotCompartmentSlot	GetPilotCompartmentSlot ()
	Returns the pilot compartment slot associated with this controller.

proto external void	SetPilotCompartmentSlot (PilotCompartmentSlot pilot)
	Sets the given compartment as the current pilot.

proto external SignalsManagerComponent	GetSignalsManager ()
	Returns the signals manager associated with this controller.

proto external BaseWeaponManagerComponent	GetWeaponManager ()
	Returns the weapon manager associated with this controller.

proto external void	Shutdown ()
	Performs actions associated with vehicle shutdown (such as input reset)

proto external bool	CanSwitchSeat ()
	Returns true if seat switching is not blocked by some action/state.

proto external bool	ArePilotControlsLocked ()
	Returns true if it is possible to switch controls. For user action script usage.

proto external void	LockPilotControls (bool bIsLocked)
	Allows/Disallows switching of controls. For user action script usage.

proto external void	CancelStart ()
	Cancels startup procedure.

proto external void	TryStartEngine ()
	Tries to start the engine with the chance of getting the engine not started based on engine startup chance.

proto external bool	StartEngine ()
	Issues a start engine input request.

proto external void	ForceStartEngine (ForceStartEngineParams params=null)
	Forcibly starts the engine without any delay, only meant for cinematics, not to be used in any game logic!

proto external void	ForceStopEngine ()
	Forcibly stops the engine without any delay, only meant for cinematics, not to be used in any game logic!

proto external void	StopEngine (bool playDriverAnimation=true)
	Stops the engine.

proto external bool	IsEngineOn ()
	Returns true if engine is running.

proto external float	GetEngineStartupChance ()
	Returns the engine startup chance in <0, 100>.

proto external void	SetEngineStartupChance (float chance)
	Sets the engine startup chance.

proto external bool	GetEngineDrowned ()
	Returns true if the engine is drowned.

proto external void	SetEngineDrowned (bool drowned)
	Sets the engine drowned.

void	OnPostInit (IEntity owner)
	Gets called after init when all components are initialized.

void	OnEngineStartBegin ()
	Gets called when the engine start routine begins (animation event - NOT IMPLEMENTED IN BASE VEHICLE).

void	OnEngineStartProgress ()
	Gets called while engine starter is active (animation event - NOT IMPLEMENTED IN BASE VEHICLE).

void	OnEngineStartInterrupt ()
	Gets called when the engine start routine was interrupted.

void	OnEngineStartSuccess ()
	Gets called when the engine start routine has successfully completed.

void	OnEngineStartFail (EVehicleEngineStartFailedReason reason)
	Gets called when the engine start routine has failed.

bool	OnBeforeEngineStart ()
	Is called every time the controller wants to start the engine.

void	OnEngineStart ()
	Is called every time the engine starts.

void	OnEngineStop ()
	Is called every time the engine stops.

Public Member Functions inherited from BaseControllerComponent
proto external IEntity	GetOwner ()
	Returns the entity owner of the component.

proto external bool	CanMove ()
	Returns state of movement capacity.

proto external void	SetCanMove (bool canMove)
	Changes state of movement capacity. Internally verifies if all necessary conditions are met.

bool	ValidateCanMove ()

Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Static Public Member Functions
static proto EVehicleDrivingAssistanceMode	GetDrivingAssistanceMode ()
	Returns the global driving assistance mode.

static proto void	SetDrivingAssistanceMode (EVehicleDrivingAssistanceMode mode)
	Sets the global driving assistance mode.

Additional Inherited Members
Protected Member Functions inherited from GameComponent
void	OnDelete (IEntity owner)
	Called when Entity is being to be destroyed (deleted) or component to be deleted.

Member Function Documentation

◆ ArePilotControlsLocked()

proto external bool BaseVehicleControllerComponent.ArePilotControlsLocked ( )

Returns true if it is possible to switch controls. For user action script usage.

◆ CancelStart()

proto external void BaseVehicleControllerComponent.CancelStart ( )

Cancels startup procedure.

◆ CanSwitchSeat()

proto external bool BaseVehicleControllerComponent.CanSwitchSeat ( )

Returns true if seat switching is not blocked by some action/state.

◆ ForceStartEngine()

proto external void BaseVehicleControllerComponent.ForceStartEngine ( ForceStartEngineParams params = null )

Forcibly starts the engine without any delay, only meant for cinematics, not to be used in any game logic!

◆ ForceStopEngine()

proto external void BaseVehicleControllerComponent.ForceStopEngine ( )

Forcibly stops the engine without any delay, only meant for cinematics, not to be used in any game logic!

◆ GetBaseSimulation()

proto external VehicleBaseSimulation BaseVehicleControllerComponent.GetBaseSimulation ( )

Returns the base of simulation component associated with this controller.

◆ GetDrivingAssistanceMode()

static proto EVehicleDrivingAssistanceMode BaseVehicleControllerComponent.GetDrivingAssistanceMode ( )

static

Returns the global driving assistance mode.

◆ GetEngineDrowned()

proto external bool BaseVehicleControllerComponent.GetEngineDrowned ( )

Returns true if the engine is drowned.

◆ GetEngineStartupChance()

proto external float BaseVehicleControllerComponent.GetEngineStartupChance ( )

Returns the engine startup chance in <0, 100>.

◆ GetFuelManager()

proto external FuelManagerComponent BaseVehicleControllerComponent.GetFuelManager ( )

Returns the fuel manager associated with this controller.

◆ GetLightManager()

proto external BaseLightManagerComponent BaseVehicleControllerComponent.GetLightManager ( )

Returns the light manager associated with this controller.

◆ GetPilotCompartmentSlot()

proto external PilotCompartmentSlot BaseVehicleControllerComponent.GetPilotCompartmentSlot ( )

Returns the pilot compartment slot associated with this controller.

◆ GetSignalsManager()

proto external SignalsManagerComponent BaseVehicleControllerComponent.GetSignalsManager ( )

Returns the signals manager associated with this controller.

◆ GetWeaponManager()

proto external BaseWeaponManagerComponent BaseVehicleControllerComponent.GetWeaponManager ( )

Returns the weapon manager associated with this controller.

◆ IsEngineOn()

proto external bool BaseVehicleControllerComponent.IsEngineOn ( )

Returns true if engine is running.

◆ LockPilotControls()

proto external void BaseVehicleControllerComponent.LockPilotControls ( bool bIsLocked )

Allows/Disallows switching of controls. For user action script usage.

◆ OnBeforeEngineStart()

bool BaseVehicleControllerComponent.OnBeforeEngineStart ( )

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

Returns: true if the engine can start, false otherwise.

Implemented in VehicleControllerComponent.

◆ OnEngineStart()

void BaseVehicleControllerComponent.OnEngineStart ( )

Is called every time the engine starts.

Implemented in VehicleControllerComponent.

◆ OnEngineStartBegin()

void BaseVehicleControllerComponent.OnEngineStartBegin ( )

Gets called when the engine start routine begins (animation event - NOT IMPLEMENTED IN BASE VEHICLE).

Implemented in VehicleControllerComponent.

◆ OnEngineStartFail()

void BaseVehicleControllerComponent.OnEngineStartFail ( EVehicleEngineStartFailedReason reason )

Gets called when the engine start routine has failed.

Implemented in VehicleControllerComponent.

◆ OnEngineStartInterrupt()

void BaseVehicleControllerComponent.OnEngineStartInterrupt ( )

Gets called when the engine start routine was interrupted.

Implemented in VehicleControllerComponent.

◆ OnEngineStartProgress()

void BaseVehicleControllerComponent.OnEngineStartProgress ( )

Gets called while engine starter is active (animation event - NOT IMPLEMENTED IN BASE VEHICLE).

Implemented in VehicleControllerComponent.

◆ OnEngineStartSuccess()

void BaseVehicleControllerComponent.OnEngineStartSuccess ( )

Gets called when the engine start routine has successfully completed.

Implemented in VehicleControllerComponent.

◆ OnEngineStop()

void BaseVehicleControllerComponent.OnEngineStop ( )

Is called every time the engine stops.

Implemented in VehicleControllerComponent.

◆ OnPostInit()

void BaseVehicleControllerComponent.OnPostInit ( IEntity owner )

Gets called after init when all components are initialized.

Implemented in VehicleControllerComponent.

◆ SetDrivingAssistanceMode()

static proto void BaseVehicleControllerComponent.SetDrivingAssistanceMode ( EVehicleDrivingAssistanceMode mode )

static

Sets the global driving assistance mode.

◆ SetEngineDrowned()

proto external void BaseVehicleControllerComponent.SetEngineDrowned ( bool drowned )

Sets the engine drowned.

Parameters

drowned True to set the engine drowned, false otherwise.

◆ SetEngineStartupChance()

proto external void BaseVehicleControllerComponent.SetEngineStartupChance ( float chance )

Sets the engine startup chance.

Parameters

chance Startup chance in <0, 100>.

◆ SetPilotCompartmentSlot()

proto external void BaseVehicleControllerComponent.SetPilotCompartmentSlot ( PilotCompartmentSlot pilot )

Sets the given compartment as the current pilot.

◆ Shutdown()

proto external void BaseVehicleControllerComponent.Shutdown ( )

Performs actions associated with vehicle shutdown (such as input reset)

◆ StartEngine()

proto external bool BaseVehicleControllerComponent.StartEngine ( )

Issues a start engine input request.

Returns: Returns true if the engine is started otherwise false.

◆ StopEngine()

proto external void BaseVehicleControllerComponent.StopEngine ( bool playDriverAnimation = true )

Stops the engine.

Parameters

playDriverAnimation The driver should play the animation or not.

◆ TryStartEngine()

proto external void BaseVehicleControllerComponent.TryStartEngine ( )

Tries to start the engine with the chance of getting the engine not started based on engine startup chance.

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

Game/generated/Vehicle/BaseVehicleControllerComponent.c

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ ArePilotControlsLocked()

◆ CancelStart()

◆ CanSwitchSeat()

◆ ForceStartEngine()

◆ ForceStopEngine()

◆ GetBaseSimulation()

◆ GetDrivingAssistanceMode()

◆ GetEngineDrowned()

◆ GetEngineStartupChance()

◆ GetFuelManager()

◆ GetLightManager()

◆ GetPilotCompartmentSlot()

◆ GetSignalsManager()

◆ GetWeaponManager()

◆ IsEngineOn()

◆ LockPilotControls()

◆ OnBeforeEngineStart()

◆ OnEngineStart()

◆ OnEngineStartBegin()

◆ OnEngineStartFail()

◆ OnEngineStartInterrupt()

◆ OnEngineStartProgress()

◆ OnEngineStartSuccess()

◆ OnEngineStop()

◆ OnPostInit()

◆ SetDrivingAssistanceMode()

◆ SetEngineDrowned()

◆ SetEngineStartupChance()

◆ SetPilotCompartmentSlot()

◆ Shutdown()

◆ StartEngine()

◆ StopEngine()

◆ TryStartEngine()