VehicleHelicopterSimulation Interface Reference

Inheritance diagram for VehicleHelicopterSimulation:

Public Member Functions
proto external void	SetThrottle (float in)
	Sets throttle input.
proto external void	EngineStart ()
	Starts the engine.
proto external void	EngineStop ()
	Stops the engine.
proto external bool	EngineIsOn ()
	Returns true if engine is running.
proto external int	RotorCount ()
	Returns number of rotors.
proto external void	RotorSetForceScaleState (int rotorIdx, float forceScale)
	Sets scaling factor of rotor force.
proto external void	RotorSetTorqueScaleState (int rotorIdx, float torqueScale)
	Sets scaling factor of rotor torque.
proto external void	RotorGetTransform (int rotorIdx, out vector transform[4])
	Returns rotor transform in local space.
proto external void	RotorGetAxis (int rotorIdx, out vector axis)
	Returns rotor axis in local space.
proto external float	RotorGetRadius (int rotorIdx)
	Returns rotor radius.
proto external SpinDirection	RotorGetSpinDirection (int rotorIdx)
	Returns rotor spin direction.
proto external float	RotorGetRPMTarget (int rotorIdx)
	Returns rotor target RPM.
proto external float	RotorGetRPM (int rotorIdx)
	Returns rotor actual RPM.
proto external RotorState	RotorGetState (int rotorIdx)
	Returns rotor state (static, spinning or destroyed)
proto external LandingGearType	LandingGearGetType ()
	Returns type of landing gear available.
proto external float	GetAltitudeAGL ()
	Returns altitude above ground level (represents terrain detection)
Public Member Functions inherited from VehicleBaseSimulation
proto external bool	IsValid ()
	Returns true if this component was properly initialized.
proto external void	GetWorldTransform (out vector mat[4])
	Returns the world transformation of a vehicle (internal physics space)
proto external vector	GetVelocity ()
	Returns the linear velocity of a vehicle [m/s].
proto external vector	GetVelocityLocal ()
	Returns the linear velocity in a vehicle local space [m/s].
proto external vector	GetAngularVelocity ()
	Returns the angular velocity of a vehicle [rad/s].
proto external vector	GetAngularVelocityLocal ()
	Returns the angular velocity in a vehicle local space [rad/s].
proto external vector	GetAcceleration ()
	Returns the linear acceleration of a vehicle [m/s^2].
proto external vector	GetAccelerationLocal ()
	Returns the linear acceleration in a vehicle local space [m/s^2].
proto external float	GetSpeedKmh ()
	Returns current vehicle speed [km/h].
proto external vector	GetGForce ()
	Returns the g-force acting on a vehicle [g(force)].
proto external float	GetGForceMagnitude ()
	Returns the total amount of g-force acting on a vehicle [g(force)].
proto external bool	HasAnyGroundContact ()
	Returns true if any wheel/landing gear has contact with ground or other object.
proto external void	SetSurfaceOverride (ResourceName surfaceMat)
	Internal use only! Overrides surface material of wheel/track casts.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Additional Inherited Members
Protected Member Functions inherited from VehicleBaseSimulation
void	OnInit (IEntity owner)
	Called during EOnInit.
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

EngineIsOn()

proto external bool VehicleHelicopterSimulation.EngineIsOn

(

)

Returns true if engine is running.

EngineStart()

proto external void VehicleHelicopterSimulation.EngineStart

(

)

Starts the engine.

EngineStop()

proto external void VehicleHelicopterSimulation.EngineStop

(

)

Stops the engine.

GetAltitudeAGL()

proto external float VehicleHelicopterSimulation.GetAltitudeAGL

(

)

Returns altitude above ground level (represents terrain detection)

LandingGearGetType()

proto external LandingGearType VehicleHelicopterSimulation.LandingGearGetType

(

)

Returns type of landing gear available.

RotorCount()

proto external int VehicleHelicopterSimulation.RotorCount

(

)

Returns number of rotors.

RotorGetAxis()

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

Returns rotor axis in local space.

RotorGetRadius()

proto external float VehicleHelicopterSimulation.RotorGetRadius

(

int

rotorIdx

)

Returns rotor radius.

RotorGetRPM()

proto external float VehicleHelicopterSimulation.RotorGetRPM

(

int

rotorIdx

)

Returns rotor actual RPM.

RotorGetRPMTarget()

proto external float VehicleHelicopterSimulation.RotorGetRPMTarget

(

int

rotorIdx

)

Returns rotor target RPM.

RotorGetSpinDirection()

proto external SpinDirection VehicleHelicopterSimulation.RotorGetSpinDirection

(

int

rotorIdx

)

Returns rotor spin direction.

RotorGetState()

proto external RotorState VehicleHelicopterSimulation.RotorGetState

(

int

rotorIdx

)

Returns rotor state (static, spinning or destroyed)

RotorGetTransform()

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

Returns rotor transform in local space.

RotorSetForceScaleState()

proto external void VehicleHelicopterSimulation.RotorSetForceScaleState	(	int	rotorIdx,
		float	forceScale )

Sets scaling factor of rotor force.

RotorSetTorqueScaleState()

proto external void VehicleHelicopterSimulation.RotorSetTorqueScaleState	(	int	rotorIdx,
		float	torqueScale )

Sets scaling factor of rotor torque.

SetThrottle()

proto external void VehicleHelicopterSimulation.SetThrottle

(

float

in

)

Sets throttle input.

Parameters

in	should be in range < 0, 1 >

---

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

• Game/generated/Vehicle/VehicleHelicopterSimulation.c