AirplaneControllerComponent Interface Reference

Inheritance diagram for AirplaneControllerComponent:

Public Member Functions
proto external VehicleFixedWingSimulation	GetSimulation ()
	Returns the simulation component associated with this controller.
Public Member Functions inherited from VehicleControllerComponent
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.
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 ()
	Is called every time the controller wants to start the engine.
override void	OnEngineStart ()
	Is called every time the engine starts.
override void	OnEngineStop ()
	Is called every time the engine stops.
override bool	ValidateCanMove ()
Public Member Functions inherited from BaseVehicleControllerComponent
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.
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.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Additional Inherited Members
Static Public Member Functions inherited from BaseVehicleControllerComponent
static proto EVehicleDrivingAssistanceMode	GetDrivingAssistanceMode ()
	Returns the global driving assistance mode.
static proto void	SetDrivingAssistanceMode (EVehicleDrivingAssistanceMode mode)
	Sets the global driving assistance mode.
Protected Member Functions inherited from VehicleControllerComponent
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)
	Gets called after init when all components are initialized.
override void	OnDelete (IEntity owner)
	Called when Entity is being to be destroyed (deleted) or component to be deleted.
Protected Attributes inherited from VehicleControllerComponent
ref ScriptInvokerVoid	m_OnEngineStart
ref ScriptInvokerVoid	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

Member Function Documentation

GetSimulation()

proto external VehicleFixedWingSimulation AirplaneControllerComponent.GetSimulation

(

)

Returns the simulation component associated with this controller.

---

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

• Game/generated/Vehicle/AirplaneControllerComponent.c