Data Structures
class	BaseCompartmentManagerComponentClass

class	BaseVehicleClass

class	CarControllerComponentClass

class	CarControllerComponent_SAClass

class	CarControllerComponent_SA_BClass

class	CargoCompartmentSlot

class	CompartmentAccessibilityContext

class	ExtBaseCompartmentSlot

class	MotorExhaustEffectComponentClass

class	PilotCompartmentSlot

class	TurretCompartmentSlot

class	VehicleFixedWingSimulationClass

class	VehicleHelicopterSimulationClass

class	VehicleTrackedSimulationClass

class	VehicleWheeledSimulationClass

class	VehicleWheeledSimulation_SAClass

class	VehicleWheeledSimulation_SA_BClass

class	VehicleWheelSound

Enumerations
enum	EHandBrakeType { HANDBRAKE_RELEASED, HANDBRAKE_HELD, HANDBRAKE_ARRESTED, HANDBRAKE_RELEASED, HANDBRAKE_HELD, HANDBRAKE_ARRESTED }

enum	EHandBrakeType { HANDBRAKE_RELEASED, HANDBRAKE_HELD, HANDBRAKE_ARRESTED, HANDBRAKE_RELEASED, HANDBRAKE_HELD, HANDBRAKE_ARRESTED }

enum	EWheelContactLiquidState { NO_CONTACT, FORDING, SUBMERGED, NO_CONTACT, FORDING, SUBMERGED }
	Describes whether wheel is in contact with some liquid. More...

enum	EWheelContactLiquidState { NO_CONTACT, FORDING, SUBMERGED, NO_CONTACT, FORDING, SUBMERGED }

enum	LandingGearType { WHEEL, SKID, WHEEL, SKID }

enum	LandingGearType { WHEEL, SKID, WHEEL, SKID }

enum	RotorState { STATIC, SPINNING, DESTROYED, STATIC, SPINNING, DESTROYED }

enum	RotorState { STATIC, SPINNING, DESTROYED, STATIC, SPINNING, DESTROYED }

enum	SpinDirection { CLOCKWISE, COUNTERCLOCKWISE, CLOCKWISE, COUNTERCLOCKWISE }

enum	SpinDirection { CLOCKWISE, COUNTERCLOCKWISE, CLOCKWISE, COUNTERCLOCKWISE }

Functions
BaseCompartmentManagerComponentClass GameComponentClass	GetOwner ()
	Owner entity of the fuel tank. More...

proto external BaseCompartmentSlot	FindCompartment (int compartmentID, int mgrId=-1)
	Searches for compartment by ID of slot and compartment manager. More...

proto external int	GetCompartments (out notnull array< BaseCompartmentSlot > outCompartments)
	Returns a list and count of all compartments. More...

BaseVehicleClass GameEntityClass	GetDamageManager ()

proto external void	SetWreckModel (ResourceName newModel)

proto external bool	IsAccessible ()
	Returns true if the vehicle is not upside down. More...

CarControllerComponentClass VehicleControllerComponentClass	Shutdown ()

proto external VehicleWheeledSimulation	GetWheeledSimulation ()
	Returns the simulation component associated with this controller. More...

proto external bool	IsThrottleTurbo ()
	returns true if throttle "turbo" modifier is active More...

proto external bool	GetHandBrake ()
	returns true if handbrake is active More...

proto external bool	GetPersistentHandBrake ()
	returns true if persistent handbrake is active More...

proto external void	SetPersistentHandBrake (bool newValue)
	sets persistent handbrake state More...

proto external void	CancelStart ()

proto external bool	HasAutomaticGearbox ()

proto external int	GetFutureGear ()

proto external int	GetCurrentGear ()

proto external VehicleWheeledSimulation	GetSimulation ()
	returns simulation component of this controllers More...

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

event void	OnEngineStartProgress ()
	Get called while engine starter is active. More...

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

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

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

event bool	OnBeforeEngineStart ()

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

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

event void	OnPostInit (IEntity owner)
	Editable Mine. More...

event void	OnDelete (IEntity owner)

proto external void	TurnOff ()
	Remove every particle associed with this effect. More...

proto external void	TurnOn (IEntity owner)

proto external EntitySlotInfo	GetEffectPosition ()

proto external float	GetSignalRpm ()

proto external float	GetSignalThrust ()

proto external float	GetRpmScaled ()

event void	OnInit (IEntity owner)

VehicleHelicopterSimulationClass VehicleBaseSimulationClass	SetThrottle (float in)

proto external void	EngineStart ()
	Starts the engine. More...

proto external void	EngineStop ()
	Stops the engine. More...

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

proto external int	RotorCount ()
	Returns number of rotors. More...

proto external void	RotorSetForceScaleState (int rotorIdx, float forceScale)
	Sets scaling factor of rotor force. More...

proto external void	RotorSetTorqueScaleState (int rotorIdx, float torqueScale)
	Sets scaling factor of rotor torque. More...

proto external void	RotorGetTransform (int rotorIdx, out vector transform[4])
	Returns rotor transform in local space. More...

proto external void	RotorGetAxis (int rotorIdx, out vector axis)
	Returns rotor axis in local space. More...

proto external float	RotorGetRadius (int rotorIdx)
	Returns rotor radius. More...

proto external SpinDirection	RotorGetSpinDirection (int rotorIdx)
	Returns rotor spin direction. More...

proto external float	RotorGetRPMTarget (int rotorIdx)
	Returns rotor target RPM. More...

proto external float	RotorGetRPM (int rotorIdx)
	Returns rotor actual RPM. More...

proto external RotorState	RotorGetState (int rotorIdx)
	Returns rotor state (static, spinning or destroyed) More...

proto external LandingGearType	LandingGearGetType ()
	Returns type of landing gear available. More...

proto external float	GetAltitudeAGL ()
	Returns altitude above ground level (represents terrain detection) More...

VehicleWheeledSimulationClass VehicleBaseSimulationClass	GetSpeedKmh ()
	Returns current vehicle speed in km/h (kilometres per hour). More...

proto external float	GetSteering ()
	Returns current steering input in range < -1, 1 > More...

proto external void	SetSteering (float in)

proto external float	GetClutch ()

proto external void	SetClutch (float in)

proto external float	GetBrake ()
	Returns current brake input in range < 0, 1 > More...

proto external void	SetBreak (float in, bool hb)

proto external float	GetThrottle ()
	returns current throttle input in range < 0, 1 > More...

proto external int	GetGear ()
	Returns index of currently engaged gear. More...

proto external void	SetGear (int in)
	Switches to given gear. More...

proto external bool	IsHandbrakeOn ()
	Returns whether handbrake is currently applied. More...

proto external float	EngineGetRPMIdle ()
	Returns idle rpm of the engine. More...

proto external float	EngineGetRPMPeakTorque ()
	Returns rpm at which engine provides maximal torque. More...

proto external float	EngineGetRPMPeakPower ()
	Returns rpm at which engine provides maximal power. More...

proto external float	EngineGetRPMMax ()
	Returns maximal working rpm before engine explodes. More...

proto external float	EngineGetRPM ()
	Returns current engine's RPM. More...

proto external float	EngineGetRPMFeedback ()
	Returns RPM that is feeded back from rest of the powertrain. More...

proto external float	EngineGetLoad ()
	Returns current engine load in range < 0, 1 > More...

proto external float	EngineGetPeakTorque ()
	Returns initial engine's peak torque in Nm (newton-metre). More...

proto external float	EngineGetPeakTorqueState ()
	Returns current engine's peak torque in Nm (newton-metre). More...

proto external void	EngineSetPeakTorqueState (float peakTorque)

proto external float	EngineGetPeakPower ()
	Returns initial engine's peak power in kW (kilowatts). More...

proto external float	EngineGetPeakPowerState ()
	Returns current engine's peak power in kW (kilowatts). More...

proto external void	EngineSetPeakPowerState (float peakPower)

proto external float	GearboxGetEfficiency ()
	Returns initial gearbox efficiency. More...

proto external float	GearboxGetEfficiencyState ()
	Returns current gearbox efficiency. More...

proto external void	GearboxSetEfficiencyState (float efficiency)
	Sets current gearbox efficiency. More...

proto external int	GearboxGearsCount ()
	Returns number of all gear ratios (neutral included). More...

proto external int	GearboxForwardGearsCount ()
	Returns number of forward gears. More...

proto external int	WheelCount ()
	Returns number of wheels. More...

proto external int	WheelGetIndex (string name)
	Returns stored index of the wheel based on its name. More...

proto external string	WheelGetName (int wheelIdx)
	Returns name of the wheel based on its index. More...

proto external vector	WheelGetPosition (int wheelIdx, float displacement=0.0)

proto external bool	WheelHasContact (int wheelIdx)
	Returns true if wheel has contact with ground or other object. More...

proto external GameMaterial	WheelGetContactMaterial (int wheelIdx)
	Returns wheel contact material. More...

proto external vector	WheelGetContactPosition (int wheelIdx)
	Returns wheel contact position in world space. More...

proto external vector	WheelGetContactNormal (int wheelIdx)
	Returns wheel contact normal. More...

proto external IEntity	WheelGetContactEntity (int wheelIdx)
	Returns entity which is in contact with wheel. More...

proto external EWheelContactLiquidState	WheelGetContactLiquidState (int wheelIdx)
	Returns whether and how is wheel in contact with some liquid. More...

proto external GameMaterial	WheelGetContactLiquidMaterial (int wheelIdx)
	Returns the material of the liquid which the wheel is in contact. More...

proto external vector	WheelGetContactLiquidPosition (int wheelIdx)
	Returns the position where the wheel touches a liquid surface. More...

proto external float	WheelGetRPM (int wheelIdx)
	Returns current wheel's RPM. More...

proto external float	WheelGetRadius (int wheelIdx)
	Returns initial wheel's radius. More...

proto external float	WheelGetRadiusState (int wheelIdx)
	Returns current wheel's radius. More...

proto external float	WheelSetRadiusState (int wheelIdx, float radius)
	Sets current wheel's radius. More...

proto external float	WheelGetMass (int wheelIdx)
	Returns initial wheel's mass. More...

proto external float	WheelGetMassState (int wheelIdx)
	Returns current wheel's mass. More...

proto external float	WheelSetMassState (int wheelIdx, float mass)
	Sets current wheel's mass. More...

proto external float	WheelGetLongitudinalSlip (int wheelIdx)
	Returns longitudinal slip of tyre. More...

proto external float	WheelGetLateralSlip (int wheelIdx)
	Returns lateral slip of tyre. More...

proto external float	WheelGetRollingDrag (int wheelIdx)
	Returns current wheel's rolling drag percentage. More...

proto external void	WheelSetRollingDrag (int wheelIdx, float drag)
	Sets current rolling drag percentage. More...

proto external float	WheelTyreGetRoughness (int wheelIdx)
	Returns initial roughness of wheel's tyre surface. More...

proto external float	WheelTyreGetRoughnessState (int wheelIdx)
	Returns current roughness of wheel's tyre surface. More...

proto external void	WheelTyreSetRoughnessState (int wheelIdx, float roughness)
	Sets current roughness of wheel's tyre surface. More...

proto external float	WheelTyreGetLongitudinalFriction (int wheelIdx)
	Returns tyre's initial longitudinal friction. More...

proto external float	WheelTyreGetLongitudinalFrictionState (int wheelIdx)
	Returns tyre's current longitudinal friction. More...

proto external void	WheelTyreSetLongitudinalFrictionState (int wheelIdx, float lngFriction)
	Sets tyre's current longitudinal friction. More...

proto external float	WheelTyreGetLateralFriction (int wheelIdx)
	Returns tyre's initial lateral friction. More...

proto external float	WheelTyreGetLateralFrictionState (int wheelIdx)
	Returns tyre's current lateral friction. More...

proto external void	WheelTyreSetLateralFrictionState (int wheelIdx, float latFriction)
	Sets tyre's current lateral friction. More...

proto external float	GetNoiseSteerSensitivity ()
	Returns sensitivity against noise steer value of surface in range < 0, 1 > More...

proto external void	SetNoiseSteerSensitivity (float newValue)

proto external float	GetRoughnessSensitivity ()
	Returns sensitivity against roughness value of surface in range < 0, 1 > More...

proto external void	SetRoughnessSensitivity (float newValue)

proto external void	ForceEnableSimulation ()

Detailed Description

Enumeration Type Documentation

◆ EHandBrakeType [1/2]

enum EHandBrakeType

Enumerator
HANDBRAKE_RELEASED
HANDBRAKE_HELD
HANDBRAKE_ARRESTED
HANDBRAKE_RELEASED
HANDBRAKE_HELD
HANDBRAKE_ARRESTED

Definition at line 12 of file EHandBrakeType.c.

◆ EHandBrakeType [2/2]

enum EHandBrakeType

Enumerator
HANDBRAKE_RELEASED
HANDBRAKE_HELD
HANDBRAKE_ARRESTED
HANDBRAKE_RELEASED
HANDBRAKE_HELD
HANDBRAKE_ARRESTED

Definition at line 12 of file EHandBrakeType.c.

◆ EWheelContactLiquidState [1/2]

enum EWheelContactLiquidState

Enumerator
NO_CONTACT	No liquid contact.
FORDING	Wheel is fording through some liquid.
SUBMERGED	Wheel is fully submerged in liquid.
NO_CONTACT	No liquid contact.
FORDING	Wheel is fording through some liquid.
SUBMERGED	Wheel is fully submerged in liquid.

Definition at line 13 of file EWheelContactLiquidState.c.

◆ EWheelContactLiquidState [2/2]

enum EWheelContactLiquidState

Describes whether wheel is in contact with some liquid.

Enumerator
NO_CONTACT	No liquid contact.
FORDING	Wheel is fording through some liquid.
SUBMERGED	Wheel is fully submerged in liquid.
NO_CONTACT	No liquid contact.
FORDING	Wheel is fording through some liquid.
SUBMERGED	Wheel is fully submerged in liquid.

Definition at line 13 of file EWheelContactLiquidState.c.

◆ LandingGearType [1/2]

enum LandingGearType

Enumerator
WHEEL
SKID
WHEEL
SKID

Definition at line 12 of file LandingGearType.c.

◆ LandingGearType [2/2]

enum LandingGearType

Enumerator
WHEEL
SKID
WHEEL
SKID

Definition at line 12 of file LandingGearType.c.

◆ RotorState [1/2]

enum RotorState

Enumerator
STATIC
SPINNING
DESTROYED
STATIC
SPINNING
DESTROYED

Definition at line 12 of file RotorState.c.

◆ RotorState [2/2]

enum RotorState

Enumerator
STATIC
SPINNING
DESTROYED
STATIC
SPINNING
DESTROYED

Definition at line 12 of file RotorState.c.

◆ SpinDirection [1/2]

enum SpinDirection

Enumerator
CLOCKWISE
COUNTERCLOCKWISE
CLOCKWISE
COUNTERCLOCKWISE

Definition at line 12 of file SpinDirection.c.

◆ SpinDirection [2/2]

enum SpinDirection

Enumerator
CLOCKWISE
COUNTERCLOCKWISE
CLOCKWISE
COUNTERCLOCKWISE

Definition at line 12 of file SpinDirection.c.

Function Documentation

◆ CancelStart()

proto external void CancelStart ( )

◆ EngineGetLoad()

proto external float EngineGetLoad ( )

Returns current engine load in range < 0, 1 >

◆ EngineGetPeakPower()

proto external float EngineGetPeakPower ( )

Returns initial engine's peak power in kW (kilowatts).

◆ EngineGetPeakPowerState()

proto external float EngineGetPeakPowerState ( )

Returns current engine's peak power in kW (kilowatts).

◆ EngineGetPeakTorque()

proto external float EngineGetPeakTorque ( )

Returns initial engine's peak torque in Nm (newton-metre).

◆ EngineGetPeakTorqueState()

proto external float EngineGetPeakTorqueState ( )

Returns current engine's peak torque in Nm (newton-metre).

◆ EngineGetRPM()

proto external float EngineGetRPM ( )

Returns current engine's RPM.

◆ EngineGetRPMFeedback()

proto external float EngineGetRPMFeedback ( )

Returns RPM that is feeded back from rest of the powertrain.

◆ EngineGetRPMIdle()

proto external float EngineGetRPMIdle ( )

Returns idle rpm of the engine.

◆ EngineGetRPMMax()

proto external float EngineGetRPMMax ( )

Returns maximal working rpm before engine explodes.

◆ EngineGetRPMPeakPower()

proto external float EngineGetRPMPeakPower ( )

Returns rpm at which engine provides maximal power.

◆ EngineGetRPMPeakTorque()

proto external float EngineGetRPMPeakTorque ( )

Returns rpm at which engine provides maximal torque.

◆ EngineIsOn()

proto external bool EngineIsOn ( )

Returns true if engine is running.

◆ EngineSetPeakPowerState()

proto external void EngineSetPeakPowerState ( float peakPower )

Sets current engine's peak power.

Parameters

peakTorque must be in kW (kilowatts).

◆ EngineSetPeakTorqueState()

proto external void EngineSetPeakTorqueState ( float peakTorque )

Sets current engine's peak torque.

Parameters

peakTorque must be in Nm (newton-metre).

◆ EngineStart()

proto external void EngineStart ( )

Starts the engine.

◆ EngineStop()

proto external void EngineStop ( )

Stops the engine.

◆ FindCompartment()

proto external BaseCompartmentSlot FindCompartment	(	int	compartmentID,
		int	mgrId = `-1`
	)

Searches for compartment by ID of slot and compartment manager.

◆ ForceEnableSimulation()

proto external void ForceEnableSimulation ( )

Forcibly enables simulation of vehicle, only meant for cinematics, not to be used in any game logic!

◆ GearboxForwardGearsCount()

proto external int GearboxForwardGearsCount ( )

Returns number of forward gears.

◆ GearboxGearsCount()

proto external int GearboxGearsCount ( )

Returns number of all gear ratios (neutral included).

◆ GearboxGetEfficiency()

proto external float GearboxGetEfficiency ( )

Returns initial gearbox efficiency.

◆ GearboxGetEfficiencyState()

proto external float GearboxGetEfficiencyState ( )

Returns current gearbox efficiency.

◆ GearboxSetEfficiencyState()

proto external void GearboxSetEfficiencyState ( float efficiency )

Sets current gearbox efficiency.

◆ GetAltitudeAGL()

proto external float GetAltitudeAGL ( )

Returns altitude above ground level (represents terrain detection)

◆ GetBrake()

proto external float GetBrake ( )

Returns current brake input in range < 0, 1 >

◆ GetClutch()

proto external float GetClutch ( )

Returns current clutch value in range < 0, 1 > 0 .. clutch disengaged 1 .. clutch fully engaged

◆ GetCompartments()

proto external int GetCompartments ( out notnull array< BaseCompartmentSlot > outCompartments )

Returns a list and count of all compartments.

◆ GetCurrentGear()

proto external int GetCurrentGear ( )

◆ GetDamageManager()

BaseVehicleClass GameEntityClass GetDamageManager ( )

◆ GetEffectPosition()

proto external EntitySlotInfo GetEffectPosition ( )

◆ GetFutureGear()

proto external int GetFutureGear ( )

◆ GetGear()

proto external int GetGear ( )

Returns index of currently engaged gear.

◆ GetHandBrake()

proto external bool GetHandBrake ( )

returns true if handbrake is active

◆ GetNoiseSteerSensitivity()

proto external float GetNoiseSteerSensitivity ( )

Returns sensitivity against noise steer value of surface in range < 0, 1 >

◆ GetOwner()

BaseCompartmentManagerComponentClass GameComponentClass GetOwner ( )

Owner entity of the fuel tank.

Returns the entity owning the component.

Returns the entity owner of the component.

This component takes care of sending chat messages.

Returns the parent entity of this component.

Returns: Entity this component is atached to.

Definition at line 128 of file SCR_FuelNode.c.

◆ GetPersistentHandBrake()

proto external bool GetPersistentHandBrake ( )

returns true if persistent handbrake is active

◆ GetRoughnessSensitivity()

proto external float GetRoughnessSensitivity ( )

Returns sensitivity against roughness value of surface in range < 0, 1 >

◆ GetRpmScaled()

proto external float GetRpmScaled ( )

Get current scaled RPM

Returns: RPM value in <0, 1>

◆ GetSignalRpm()

proto external float GetSignalRpm ( )

Get current RPM

Returns: RPM value in <0, maxRpm>

◆ GetSignalThrust()

proto external float GetSignalThrust ( )

◆ GetSimulation()

proto external VehicleWheeledSimulation_SA_B GetSimulation ( )

returns simulation component of this controllers

◆ GetSpeedKmh()

VehicleWheeledSimulation_SA_BClass VehicleBaseSimulationClass GetSpeedKmh ( )

Returns current vehicle speed in km/h (kilometres per hour).

Returns current vehicle speed in km/h (kilometers per hour).

◆ GetSteering()

proto external float GetSteering ( )

Returns current steering input in range < -1, 1 >

◆ GetThrottle()

proto external float GetThrottle ( )

returns current throttle input in range < 0, 1 >

◆ GetWheeledSimulation()

CarControllerComponent_SA_BClass VehicleControllerComponent_SAClass GetWheeledSimulation ( )

Returns the simulation component associated with this controller.

◆ HasAutomaticGearbox()

proto external bool HasAutomaticGearbox ( )

◆ IsAccessible()

proto external bool IsAccessible ( )

Returns true if the vehicle is not upside down.

◆ IsHandbrakeOn()

proto external bool IsHandbrakeOn ( )

Returns whether handbrake is currently applied.

◆ IsThrottleTurbo()

proto external bool IsThrottleTurbo ( )

returns true if throttle "turbo" modifier is active

◆ LandingGearGetType()

proto external LandingGearType LandingGearGetType ( )

Returns type of landing gear available.

◆ OnBeforeEngineStart()

event bool OnBeforeEngineStart ( )

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

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

◆ OnDelete()

event void OnDelete ( IEntity owner )

Called during EOnInit.

Parameters

owner Entity this component is attached to.

Definition at line 538 of file SCR_CampaignBuildingCompositionComponent.c.

◆ OnEngineStart()

event void OnEngineStart ( )

Is called every time the engine starts.

◆ OnEngineStartBegin()

event void OnEngineStartBegin ( )

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

◆ OnEngineStartFail()

event void OnEngineStartFail ( EVehicleEngineStartFailedReason reason )

Gets called when the engine start routine has failed.

◆ OnEngineStartInterrupt()

event void OnEngineStartInterrupt ( )

Gets called when the engine start routine was interrupted.

◆ OnEngineStartProgress()

event void OnEngineStartProgress ( )

Get called while engine starter is active.

◆ OnEngineStartSuccess()

event void OnEngineStartSuccess ( )

Gets called when the engine start routine has successfully completed.

◆ OnEngineStop()

event void OnEngineStop ( )

Is called every time the engine stops.

Definition at line 332 of file SCR_MotorExhaustEffectGeneralComponent.c.

◆ OnInit()

event void OnInit ( IEntity owner )

Called during EOnInit.

Parameters

owner Entity this component is attached to.

Definition at line 523 of file SCR_CharacterCommandHandler_Tests.c.

◆ OnPostInit()

event void OnPostInit ( IEntity owner )

Editable Mine.

Called after all components are initialized.

Parameters

owner Entity this component is attached to.

Returns XP reward skill

Parameters

[in] reward

Returns

Called after all components are initialized.

Parameters

owner Entity this component is attached to.

Returns XP reward skill

Parameters

[in] reward

Returns

Editable Mine.

Called after all components are initialized.

Parameters

owner Entity this component is attached to.

Returns XP reward skill

Parameters

[in] reward

Returns

Editable Mine.

Initialises the handler by finding necessary dependencies.

Parameters

[in] owner

Initialises the component by finding necessary dependencies.

Parameters

[in] owner

Called after all components are initialized.

Parameters

owner Entity this component is attached to.

Returns XP reward skill

Parameters

[in] reward

Returns

Editable Mine.

Initialises the handler by finding necessary dependencies.

Parameters

[in] owner

Initialises the component by finding necessary dependencies.

Parameters

[in] owner

Initialises the component, the consumer and/or the container. Event called after init when all components are initialised.

Parameters

[in] owner Entity that owns this component.

Called after all components are initialized.

Parameters

owner Entity this component is attached to.

Returns XP reward skill

Parameters

[in] reward

Returns

Editable Mine.

Initialises the handler by finding necessary dependencies.

Parameters

[in] owner

Initialises the component by finding necessary dependencies.

Parameters

[in] owner

Initialises the component, the consumer and/or the container. Event called after init when all components are initialised.

Parameters

[in] owner Entity that owns this component.

Definition at line 72 of file SCR_AIConfigComponent.c.

◆ RotorCount()

proto external int RotorCount ( )

Returns number of rotors.

◆ RotorGetAxis()

proto external void RotorGetAxis	(	int	rotorIdx,
		out vector	axis
	)

Returns rotor axis in local space.

◆ RotorGetRadius()

proto external float RotorGetRadius ( int rotorIdx )

Returns rotor radius.

◆ RotorGetRPM()

proto external float RotorGetRPM ( int rotorIdx )

Returns rotor actual RPM.

◆ RotorGetRPMTarget()

proto external float RotorGetRPMTarget ( int rotorIdx )

Returns rotor target RPM.

◆ RotorGetSpinDirection()

proto external SpinDirection RotorGetSpinDirection ( int rotorIdx )

Returns rotor spin direction.

◆ RotorGetState()

proto external RotorState RotorGetState ( int rotorIdx )

Returns rotor state (static, spinning or destroyed)

◆ RotorGetTransform()

proto external void RotorGetTransform	(	int	rotorIdx,
		out vector	transform[4]
	)

Returns rotor transform in local space.

◆ RotorSetForceScaleState()

proto external void RotorSetForceScaleState	(	int	rotorIdx,
		float	forceScale
	)

Sets scaling factor of rotor force.

◆ RotorSetTorqueScaleState()

proto external void RotorSetTorqueScaleState	(	int	rotorIdx,
		float	torqueScale
	)

Sets scaling factor of rotor torque.

◆ SetBreak()

proto external void SetBreak	(	float	in,
		bool	hb
	)

Sets brake inputs

Parameters

in	should be in range < 0, 1 >
hb	indicating whether handbrake should be applied

◆ SetClutch()

proto external void SetClutch ( float in )

Sets the clutch input

Parameters

in	should be in range < 0, 1 >

◆ SetGear()

proto external void SetGear ( int in )

Switches to given gear.

◆ SetNoiseSteerSensitivity()

proto external void SetNoiseSteerSensitivity ( float newValue )

Sets sensitivity on noise steer

Parameters

newValue should be in range < 0, 1 >

◆ SetPersistentHandBrake()

proto external void SetPersistentHandBrake ( bool newValue )

sets persistent handbrake state

◆ SetRoughnessSensitivity()

proto external void SetRoughnessSensitivity ( float newValue )

Sets sensitivity on roughness value of surface

Parameters

newValue should be in range < 0, 1 >

◆ SetSteering()

proto external void SetSteering ( float in )

Sets steering input.

Parameters

in	should be in range < -1, 1 >

◆ SetThrottle()

proto external void SetThrottle ( float in )

Sets throttle input

Parameters

in	should be in range < 0, 1 >

◆ SetWreckModel()

proto external void SetWreckModel ( ResourceName newModel )

Sets the wreck model of the vehicle. This will change the state of the vehicle to a wrecked vehicle which means some components will be deactivated.

Parameters

newModel New model which should be displayed

◆ Shutdown()

CarControllerComponentClass VehicleControllerComponentClass Shutdown ( )

◆ TurnOff()

proto external void TurnOff ( )

Remove every particle associed with this effect.

Definition at line 91 of file SCR_FireplaceComponent.c.

◆ TurnOn()

proto external void TurnOn ( IEntity owner )

Active particle associed with this effect

Parameters

owner Owner of this component

◆ WheelCount()

proto external int WheelCount ( )

Returns number of wheels.

◆ WheelGetContactEntity()

proto external IEntity WheelGetContactEntity ( int wheelIdx )

Returns entity which is in contact with wheel.

◆ WheelGetContactLiquidMaterial()

proto external GameMaterial WheelGetContactLiquidMaterial ( int wheelIdx )

Returns the material of the liquid which the wheel is in contact.

◆ WheelGetContactLiquidPosition()

proto external vector WheelGetContactLiquidPosition ( int wheelIdx )

Returns the position where the wheel touches a liquid surface.

◆ WheelGetContactLiquidState()

proto external EWheelContactLiquidState WheelGetContactLiquidState ( int wheelIdx )

Returns whether and how is wheel in contact with some liquid.

◆ WheelGetContactMaterial()

proto external GameMaterial WheelGetContactMaterial ( int wheelIdx )

Returns wheel contact material.

◆ WheelGetContactNormal()

proto external vector WheelGetContactNormal ( int wheelIdx )

Returns wheel contact normal.

◆ WheelGetContactPosition()

proto external vector WheelGetContactPosition ( int wheelIdx )

Returns wheel contact position in world space.

◆ WheelGetIndex()

proto external int WheelGetIndex ( string name )

Returns stored index of the wheel based on its name.

◆ WheelGetLateralSlip()

proto external float WheelGetLateralSlip ( int wheelIdx )

Returns lateral slip of tyre.

◆ WheelGetLongitudinalSlip()

proto external float WheelGetLongitudinalSlip ( int wheelIdx )

Returns longitudinal slip of tyre.

◆ WheelGetMass()

proto external float WheelGetMass ( int wheelIdx )

Returns initial wheel's mass.

◆ WheelGetMassState()

proto external float WheelGetMassState ( int wheelIdx )

Returns current wheel's mass.

◆ WheelGetName()

proto external string WheelGetName ( int wheelIdx )

Returns name of the wheel based on its index.

◆ WheelGetPosition()

proto external vector WheelGetPosition	(	int	wheelIdx,
		float	displacement = `0.0`
	)

Get the wheel position based on suspension.

Parameters

wheelIdx	Index of the wheel
displacement	0 means the position of the wheel when the suspension is fully extended ( zero g ).

Returns: Returns wheel position in local space.

◆ WheelGetRadius()

proto external float WheelGetRadius ( int wheelIdx )

Returns initial wheel's radius.

◆ WheelGetRadiusState()

proto external float WheelGetRadiusState ( int wheelIdx )

Returns current wheel's radius.

◆ WheelGetRollingDrag()

proto external float WheelGetRollingDrag ( int wheelIdx )

Returns current wheel's rolling drag percentage.

◆ WheelGetRPM()

proto external float WheelGetRPM ( int wheelIdx )

Returns current wheel's RPM.

◆ WheelHasContact()

proto external bool WheelHasContact ( int wheelIdx )

Returns true if wheel has contact with ground or other object.

◆ WheelSetMassState()

proto external float WheelSetMassState	(	int	wheelIdx,
		float	mass
	)

Sets current wheel's mass.

◆ WheelSetRadiusState()

proto external float WheelSetRadiusState	(	int	wheelIdx,
		float	radius
	)

Sets current wheel's radius.

◆ WheelSetRollingDrag()

proto external void WheelSetRollingDrag	(	int	wheelIdx,
		float	drag
	)

Sets current rolling drag percentage.

◆ WheelTyreGetLateralFriction()

proto external float WheelTyreGetLateralFriction ( int wheelIdx )

Returns tyre's initial lateral friction.

◆ WheelTyreGetLateralFrictionState()

proto external float WheelTyreGetLateralFrictionState ( int wheelIdx )

Returns tyre's current lateral friction.

◆ WheelTyreGetLongitudinalFriction()

proto external float WheelTyreGetLongitudinalFriction ( int wheelIdx )

Returns tyre's initial longitudinal friction.

◆ WheelTyreGetLongitudinalFrictionState()

proto external float WheelTyreGetLongitudinalFrictionState ( int wheelIdx )

Returns tyre's current longitudinal friction.

◆ WheelTyreGetRoughness()

proto external float WheelTyreGetRoughness ( int wheelIdx )

Returns initial roughness of wheel's tyre surface.

◆ WheelTyreGetRoughnessState()

proto external float WheelTyreGetRoughnessState ( int wheelIdx )

Returns current roughness of wheel's tyre surface.

◆ WheelTyreSetLateralFrictionState()

proto external void WheelTyreSetLateralFrictionState	(	int	wheelIdx,
		float	latFriction
	)

Sets tyre's current lateral friction.

◆ WheelTyreSetLongitudinalFrictionState()

proto external void WheelTyreSetLongitudinalFrictionState	(	int	wheelIdx,
		float	lngFriction
	)

Sets tyre's current longitudinal friction.

◆ WheelTyreSetRoughnessState()

proto external void WheelTyreSetRoughnessState	(	int	wheelIdx,
		float	roughness
	)

Sets current roughness of wheel's tyre surface.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ EHandBrakeType [1/2]

◆ EHandBrakeType [2/2]

◆ EWheelContactLiquidState [1/2]

◆ EWheelContactLiquidState [2/2]

◆ LandingGearType [1/2]

◆ LandingGearType [2/2]

◆ RotorState [1/2]

◆ RotorState [2/2]

◆ SpinDirection [1/2]

◆ SpinDirection [2/2]

Function Documentation

◆ CancelStart()

◆ EngineGetLoad()

◆ EngineGetPeakPower()

◆ EngineGetPeakPowerState()

◆ EngineGetPeakTorque()

◆ EngineGetPeakTorqueState()

◆ EngineGetRPM()

◆ EngineGetRPMFeedback()

◆ EngineGetRPMIdle()

◆ EngineGetRPMMax()

◆ EngineGetRPMPeakPower()

◆ EngineGetRPMPeakTorque()

◆ EngineIsOn()

◆ EngineSetPeakPowerState()

◆ EngineSetPeakTorqueState()

◆ EngineStart()

◆ EngineStop()

◆ FindCompartment()

◆ ForceEnableSimulation()

◆ GearboxForwardGearsCount()

◆ GearboxGearsCount()

◆ GearboxGetEfficiency()

◆ GearboxGetEfficiencyState()

◆ GearboxSetEfficiencyState()

◆ GetAltitudeAGL()

◆ GetBrake()

◆ GetClutch()

◆ GetCompartments()

◆ GetCurrentGear()

◆ GetDamageManager()

◆ GetEffectPosition()

◆ GetFutureGear()

◆ GetGear()

◆ GetHandBrake()

◆ GetNoiseSteerSensitivity()

◆ GetOwner()

◆ GetPersistentHandBrake()

◆ GetRoughnessSensitivity()

◆ GetRpmScaled()

◆ GetSignalRpm()

◆ GetSignalThrust()

◆ GetSimulation()

◆ GetSpeedKmh()

◆ GetSteering()

◆ GetThrottle()

◆ GetWheeledSimulation()

◆ HasAutomaticGearbox()

◆ IsAccessible()

◆ IsHandbrakeOn()

◆ IsThrottleTurbo()

◆ LandingGearGetType()

◆ OnBeforeEngineStart()

◆ OnDelete()

◆ OnEngineStart()

◆ OnEngineStartBegin()

◆ OnEngineStartFail()

◆ OnEngineStartInterrupt()

◆ OnEngineStartProgress()

◆ OnEngineStartSuccess()

◆ OnEngineStop()

◆ OnInit()

◆ OnPostInit()

◆ RotorCount()

◆ RotorGetAxis()