Classes
class	AirplaneControllerComponent
class	AirplaneControllerComponentClass
class	BaseCompartmentManagerComponent
class	BaseCompartmentManagerComponentClass
class	BaseVehicle
class	BaseVehicleClass
class	BaseVehicleControllerComponent
class	BaseVehicleControllerComponentClass
class	CarControllerComponent
class	CarControllerComponent_B
class	CarControllerComponent_BClass
class	CarControllerComponentClass
class	CargoCompartmentSlot
class	CommonStateV1
class	CompartmentAccessibilityContext
class	EmissiveLightSurfaceSlot
class	ExtBaseCompartmentSlot
class	ForceStartEngineParams
class	HelicopterControllerComponent
class	HelicopterControllerComponentClass
class	MotorExhaustEffectComponentClass
class	PilotCompartmentSlot
class	TrackedControllerComponent
class	TrackedControllerComponentClass
class	TurretCompartmentSlot
class	VehicleBaseSimulation
class	VehicleBaseSimulationClass
class	VehicleFixedWingSimulation
class	VehicleFixedWingSimulationClass
class	VehicleHelicopterSimulation
class	VehicleHelicopterSimulationClass
class	VehicleTrackedSimulation
class	VehicleTrackedSimulationClass
class	VehicleWheeledSimulation
class	VehicleWheeledSimulation_SA_B
class	VehicleWheeledSimulation_SA_BClass
class	VehicleWheeledSimulationClass
class	VehicleWheelSound

Enumerations
enum	CollectiveMode { LocalYOffsetAuto , LocalYOffsetManual , Sticky , Direct , LocalY , WorldY , LocalYOffsetAuto , LocalYOffsetManual , Sticky , Direct , LocalY , WorldY }
enum	CollectiveMode { LocalYOffsetAuto , LocalYOffsetManual , Sticky , Direct , LocalY , WorldY , LocalYOffsetAuto , LocalYOffsetManual , Sticky , Direct , LocalY , WorldY }
enum	ECharacterDoorAnimType { INVALID , FROM_OUTSIDE , FROM_INSIDE , FROM_OUTSIDE_BACK , NO_CHARACTER_ANIM , MAX , INVALID , FROM_OUTSIDE , FROM_INSIDE , FROM_OUTSIDE_BACK , NO_CHARACTER_ANIM , MAX }
enum	ECharacterDoorAnimType { INVALID , FROM_OUTSIDE , FROM_INSIDE , FROM_OUTSIDE_BACK , NO_CHARACTER_ANIM , MAX , INVALID , FROM_OUTSIDE , FROM_INSIDE , FROM_OUTSIDE_BACK , NO_CHARACTER_ANIM , MAX }
enum	ECloseDoorAfterActions { INVALID , CLOSE_DOOR , LEAVE_OPEN , RETURN_TO_PREVIOUS_STATE , MAX , INVALID , CLOSE_DOOR , LEAVE_OPEN , RETURN_TO_PREVIOUS_STATE , MAX }
enum	ECloseDoorAfterActions { INVALID , CLOSE_DOOR , LEAVE_OPEN , RETURN_TO_PREVIOUS_STATE , MAX , INVALID , CLOSE_DOOR , LEAVE_OPEN , RETURN_TO_PREVIOUS_STATE , MAX }
enum	EGetOutType { ANIMATED , TELEPORT , TELEPORT_WITH_OPEN_DOOR , MAX , ANIMATED , TELEPORT , TELEPORT_WITH_OPEN_DOOR , MAX }
enum	EGetOutType { ANIMATED , TELEPORT , TELEPORT_WITH_OPEN_DOOR , MAX , ANIMATED , TELEPORT , TELEPORT_WITH_OPEN_DOOR , MAX }
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
MotorExhaustEffectComponentClass BaseEffectComponentClass	GetOwner ()
	Owner entity of the fuel tank.
proto external void	TurnOff ()
	Remove every particle associed with this effect.
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)

Detailed Description

Enumeration Type Documentation

◆ CollectiveMode [1/2]

enum CollectiveMode

Enumerator
LocalYOffsetAuto
LocalYOffsetManual
Sticky
Direct
LocalY
WorldY
LocalYOffsetAuto
LocalYOffsetManual
Sticky
Direct
LocalY
WorldY

Definition at line 12 of file CollectiveMode.c.

◆ CollectiveMode [2/2]

enum CollectiveMode

Enumerator
LocalYOffsetAuto
LocalYOffsetManual
Sticky
Direct
LocalY
WorldY
LocalYOffsetAuto
LocalYOffsetManual
Sticky
Direct
LocalY
WorldY

Definition at line 12 of file CollectiveMode.c.

◆ ECharacterDoorAnimType [1/2]

enum ECharacterDoorAnimType

Enumerator
INVALID
FROM_OUTSIDE
FROM_INSIDE
FROM_OUTSIDE_BACK
NO_CHARACTER_ANIM
MAX
INVALID
FROM_OUTSIDE
FROM_INSIDE
FROM_OUTSIDE_BACK
NO_CHARACTER_ANIM
MAX

Definition at line 12 of file ECharacterDoorAnimType.c.

◆ ECharacterDoorAnimType [2/2]

enum ECharacterDoorAnimType

Enumerator
INVALID
FROM_OUTSIDE
FROM_INSIDE
FROM_OUTSIDE_BACK
NO_CHARACTER_ANIM
MAX
INVALID
FROM_OUTSIDE
FROM_INSIDE
FROM_OUTSIDE_BACK
NO_CHARACTER_ANIM
MAX

Definition at line 12 of file ECharacterDoorAnimType.c.

◆ ECloseDoorAfterActions [1/2]

enum ECloseDoorAfterActions

Enumerator
INVALID
CLOSE_DOOR
LEAVE_OPEN
RETURN_TO_PREVIOUS_STATE
MAX
INVALID
CLOSE_DOOR
LEAVE_OPEN
RETURN_TO_PREVIOUS_STATE
MAX

Definition at line 12 of file ECloseDoorAfterActions.c.

◆ ECloseDoorAfterActions [2/2]

enum ECloseDoorAfterActions

Enumerator
INVALID
CLOSE_DOOR
LEAVE_OPEN
RETURN_TO_PREVIOUS_STATE
MAX
INVALID
CLOSE_DOOR
LEAVE_OPEN
RETURN_TO_PREVIOUS_STATE
MAX

Definition at line 12 of file ECloseDoorAfterActions.c.

◆ EGetOutType [1/2]

enum EGetOutType

Enumerator
ANIMATED
TELEPORT
TELEPORT_WITH_OPEN_DOOR
MAX
ANIMATED
TELEPORT
TELEPORT_WITH_OPEN_DOOR
MAX

Definition at line 12 of file EGetOutType.c.

◆ EGetOutType [2/2]

enum EGetOutType

Enumerator
ANIMATED
TELEPORT
TELEPORT_WITH_OPEN_DOOR
MAX
ANIMATED
TELEPORT
TELEPORT_WITH_OPEN_DOOR
MAX

Definition at line 12 of file EGetOutType.c.

◆ 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

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.

◆ EWheelContactLiquidState [2/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.

◆ 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

◆ GetEffectPosition()

proto external EntitySlotInfo GetEffectPosition ( )

◆ GetOwner()

MotorExhaustEffectComponentClass BaseEffectComponentClass 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.

◆ 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 ( )

◆ OnInit()

event void OnInit ( IEntity owner )

Called during EOnInit.

Parameters

owner Entity this component is attached to.

Definition at line 493 of file SCR_CharacterCommandHandler_Tests.c.

◆ 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