VehicleWheeledSimulation Interface Reference

Inheritance diagram for VehicleWheeledSimulation:

Public Member Functions
proto external float	GetSpeedKmh ()
	Returns current vehicle speed in km/h (kilometers per hour).
proto external void	ForceEnableSimulation ()
	Forcibly enables simulation of vehicle, only meant for cinematics, not to be used in any game logic!
proto external float	GetSteering ()
	Returns current steering input in range < -1, 1 >
proto external void	SetSteering (float in)
	Sets steering input.
proto external float	GetClutch ()
	Returns current clutch value in range < 0, 1 > 0 .
proto external void	SetClutch (float in)
	Sets the clutch input.
proto external float	GetBrake ()
	Returns current brake input in range < 0, 1 >
proto external void	SetBreak (float in, bool hb)
	Sets brake inputs.
proto external float	GetThrottle ()
	returns current throttle input in range < 0, 1 >
proto external void	SetThrottle (float in)
	Sets throttle input.
proto external int	GetGear ()
	Returns index of currently engaged gear.
proto external void	SetGear (int in)
	Switches to given gear.
proto external bool	IsHandbrakeOn ()
	Returns whether handbrake is currently applied.
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 float	EngineGetRPMIdle ()
	Returns idle rpm of the engine.
proto external float	EngineGetRPMPeakTorque ()
	Returns rpm at which engine provides maximal torque.
proto external float	EngineGetRPMPeakPower ()
	Returns rpm at which engine provides maximal power.
proto external float	EngineGetRPMMax ()
	Returns maximal working rpm before engine explodes.
proto external float	EngineGetRPM ()
	Returns current engine's RPM.
proto external float	EngineGetRPMFeedback ()
	Returns RPM that is feeded back from rest of the powertrain.
proto external float	EngineGetLoad ()
	Returns current engine load in range < 0, 1 >
proto external float	EngineGetPeakTorque ()
	Returns initial engine's peak torque in Nm (newton-metre).
proto external float	EngineGetPeakTorqueState ()
	Returns current engine's peak torque in Nm (newton-metre).
proto external void	EngineSetPeakTorqueState (float peakTorque)
	Sets current engine's peak torque.
proto external float	EngineGetPeakPower ()
	Returns initial engine's peak power in kW (kilowatts).
proto external float	EngineGetPeakPowerState ()
	Returns current engine's peak power in kW (kilowatts).
proto external void	EngineSetPeakPowerState (float peakPower)
	Sets current engine's peak power.
proto external float	GearboxGetEfficiency ()
	Returns initial gearbox efficiency.
proto external float	GearboxGetEfficiencyState ()
	Returns current gearbox efficiency.
proto external void	GearboxSetEfficiencyState (float efficiency)
	Sets current gearbox efficiency.
proto external int	GearboxGearsCount ()
	Returns number of all gear ratios (neutral included).
proto external int	GearboxForwardGearsCount ()
	Returns number of forward gears.
proto external int	WheelCount ()
	Returns number of wheels.
proto external int	WheelGetIndex (string name)
	Returns stored index of the wheel based on its name.
proto external string	WheelGetName (int wheelIdx)
	Returns name of the wheel based on its index.
proto external vector	WheelGetPosition (int wheelIdx, float displacement=0.0)
	Get the wheel position based on suspension.
proto external bool	WheelHasContact (int wheelIdx)
	Returns true if wheel has contact with ground or other object.
proto external GameMaterial	WheelGetContactMaterial (int wheelIdx)
	Returns wheel contact material.
proto external vector	WheelGetContactPosition (int wheelIdx)
	Returns wheel contact position in world space.
proto external vector	WheelGetContactNormal (int wheelIdx)
	Returns wheel contact normal.
proto external IEntity	WheelGetContactEntity (int wheelIdx)
	Returns entity which is in contact with wheel.
proto external EWheelContactLiquidState	WheelGetContactLiquidState (int wheelIdx)
	Returns whether and how is wheel in contact with some liquid.
proto external GameMaterial	WheelGetContactLiquidMaterial (int wheelIdx)
	Returns the material of the liquid which the wheel is in contact.
proto external vector	WheelGetContactLiquidPosition (int wheelIdx)
	Returns the position where the wheel touches a liquid surface.
proto external float	WheelGetRPM (int wheelIdx)
	Returns current wheel's RPM.
proto external float	WheelGetRadius (int wheelIdx)
	Returns initial wheel's radius.
proto external float	WheelGetRadiusState (int wheelIdx)
	Returns current wheel's radius.
proto external float	WheelSetRadiusState (int wheelIdx, float radius)
	Sets current wheel's radius.
proto external float	WheelGetMass (int wheelIdx)
	Returns initial wheel's mass.
proto external float	WheelGetMassState (int wheelIdx)
	Returns current wheel's mass.
proto external float	WheelSetMassState (int wheelIdx, float mass)
	Sets current wheel's mass.
proto external float	WheelGetLongitudinalSlip (int wheelIdx)
	Returns longitudinal slip of tyre.
proto external float	WheelGetLateralSlip (int wheelIdx)
	Returns lateral slip of tyre.
proto external float	WheelGetRollingDrag (int wheelIdx)
	Returns current wheel's rolling drag percentage.
proto external void	WheelSetRollingDrag (int wheelIdx, float drag)
	Sets current rolling drag percentage.
proto external float	WheelTyreGetRoughness (int wheelIdx)
	Returns initial roughness of wheel's tyre surface.
proto external float	WheelTyreGetRoughnessState (int wheelIdx)
	Returns current roughness of wheel's tyre surface.
proto external void	WheelTyreSetRoughnessState (int wheelIdx, float roughness)
	Sets current roughness of wheel's tyre surface.
proto external float	WheelTyreGetLongitudinalFriction (int wheelIdx)
	Returns tyre's initial longitudinal friction.
proto external float	WheelTyreGetLongitudinalFrictionState (int wheelIdx)
	Returns tyre's current longitudinal friction.
proto external void	WheelTyreSetLongitudinalFrictionState (int wheelIdx, float lngFriction)
	Sets tyre's current longitudinal friction.
proto external float	WheelTyreGetLateralFriction (int wheelIdx)
	Returns tyre's initial lateral friction.
proto external float	WheelTyreGetLateralFrictionState (int wheelIdx)
	Returns tyre's current lateral friction.
proto external void	WheelTyreSetLateralFrictionState (int wheelIdx, float latFriction)
	Sets tyre's current lateral friction.
proto external float	GetNoiseSteerSensitivity ()
	Returns sensitivity against noise steer value of surface in range < 0, 1 >
proto external void	SetNoiseSteerSensitivity (float newValue)
	Sets sensitivity on noise steer.
proto external float	GetRoughnessSensitivity ()
	Returns sensitivity against roughness value of surface in range < 0, 1 >
proto external void	SetRoughnessSensitivity (float newValue)
	Sets sensitivity on roughness value of surface.
Public Member Functions inherited from VehicleBaseSimulation
proto external bool	HasAnyGroundContact ()
	Returns true if any wheel/landing gear has contact with ground or other object.
proto external vector	GetGForce ()
	Returns the acceleration of the vehicle produced by mechanical forces.
proto external float	GetGForceMagnitude ()
	Returns the total amount of acceleration of the vehicle produced by mechanical forces.
proto external bool	IsValid ()
	Returns true if this component was properly initialized.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Additional Inherited Members
Protected Member Functions inherited from VehicleBaseSimulation
void	OnInit (IEntity owner)
	Called during EOnInit.

Member Function Documentation

EngineGetLoad()

proto external float VehicleWheeledSimulation.EngineGetLoad

(

)

Returns current engine load in range < 0, 1 >

EngineGetPeakPower()

proto external float VehicleWheeledSimulation.EngineGetPeakPower

(

)

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

EngineGetPeakPowerState()

proto external float VehicleWheeledSimulation.EngineGetPeakPowerState

(

)

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

EngineGetPeakTorque()

proto external float VehicleWheeledSimulation.EngineGetPeakTorque

(

)

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

EngineGetPeakTorqueState()

proto external float VehicleWheeledSimulation.EngineGetPeakTorqueState

(

)

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

EngineGetRPM()

proto external float VehicleWheeledSimulation.EngineGetRPM

(

)

Returns current engine's RPM.

EngineGetRPMFeedback()

proto external float VehicleWheeledSimulation.EngineGetRPMFeedback

(

)

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

EngineGetRPMIdle()

proto external float VehicleWheeledSimulation.EngineGetRPMIdle

(

)

Returns idle rpm of the engine.

EngineGetRPMMax()

proto external float VehicleWheeledSimulation.EngineGetRPMMax

(

)

Returns maximal working rpm before engine explodes.

EngineGetRPMPeakPower()

proto external float VehicleWheeledSimulation.EngineGetRPMPeakPower

(

)

Returns rpm at which engine provides maximal power.

EngineGetRPMPeakTorque()

proto external float VehicleWheeledSimulation.EngineGetRPMPeakTorque

(

)

Returns rpm at which engine provides maximal torque.

EngineIsOn()

proto external bool VehicleWheeledSimulation.EngineIsOn

(

)

Returns true if engine is running.

EngineSetPeakPowerState()

proto external void VehicleWheeledSimulation.EngineSetPeakPowerState

(

float

peakPower

)

Sets current engine's peak power.

Parameters

peakTorque

must be in kW (kilowatts).

EngineSetPeakTorqueState()

proto external void VehicleWheeledSimulation.EngineSetPeakTorqueState

(

float

peakTorque

)

Sets current engine's peak torque.

Parameters

peakTorque

must be in Nm (newton-metre).

EngineStart()

proto external void VehicleWheeledSimulation.EngineStart

(

)

Starts the engine.

EngineStop()

proto external void VehicleWheeledSimulation.EngineStop

(

)

Stops the engine.

ForceEnableSimulation()

proto external void VehicleWheeledSimulation.ForceEnableSimulation

(

)

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

GearboxForwardGearsCount()

proto external int VehicleWheeledSimulation.GearboxForwardGearsCount

(

)

Returns number of forward gears.

GearboxGearsCount()

proto external int VehicleWheeledSimulation.GearboxGearsCount

(

)

Returns number of all gear ratios (neutral included).

GearboxGetEfficiency()

proto external float VehicleWheeledSimulation.GearboxGetEfficiency

(

)

Returns initial gearbox efficiency.

GearboxGetEfficiencyState()

proto external float VehicleWheeledSimulation.GearboxGetEfficiencyState

(

)

Returns current gearbox efficiency.

GearboxSetEfficiencyState()

proto external void VehicleWheeledSimulation.GearboxSetEfficiencyState

(

float

efficiency

)

Sets current gearbox efficiency.

GetBrake()

proto external float VehicleWheeledSimulation.GetBrake

(

)

Returns current brake input in range < 0, 1 >

GetClutch()

proto external float VehicleWheeledSimulation.GetClutch

(

)

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

. clutch disengaged 1 .. clutch fully engaged

GetGear()

proto external int VehicleWheeledSimulation.GetGear

(

)

Returns index of currently engaged gear.

GetNoiseSteerSensitivity()

proto external float VehicleWheeledSimulation.GetNoiseSteerSensitivity

(

)

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

GetRoughnessSensitivity()

proto external float VehicleWheeledSimulation.GetRoughnessSensitivity

(

)

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

GetSpeedKmh()

proto external float VehicleWheeledSimulation.GetSpeedKmh

(

)

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

GetSteering()

proto external float VehicleWheeledSimulation.GetSteering

(

)

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

GetThrottle()

proto external float VehicleWheeledSimulation.GetThrottle

(

)

returns current throttle input in range < 0, 1 >

IsHandbrakeOn()

proto external bool VehicleWheeledSimulation.IsHandbrakeOn

(

)

Returns whether handbrake is currently applied.

SetBreak()

proto external void VehicleWheeledSimulation.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 VehicleWheeledSimulation.SetClutch

(

float

in

)

Sets the clutch input.

Parameters

in	should be in range < 0, 1 >

SetGear()

proto external void VehicleWheeledSimulation.SetGear

(

int

in

)

Switches to given gear.

SetNoiseSteerSensitivity()

proto external void VehicleWheeledSimulation.SetNoiseSteerSensitivity

(

float

newValue

)

Sets sensitivity on noise steer.

Parameters

newValue

should be in range < 0, 1 >

SetRoughnessSensitivity()

proto external void VehicleWheeledSimulation.SetRoughnessSensitivity

(

float

newValue

)

Sets sensitivity on roughness value of surface.

Parameters

newValue

should be in range < 0, 1 >

SetSteering()

proto external void VehicleWheeledSimulation.SetSteering

(

float

in

)

Sets steering input.

Parameters

in	should be in range < -1, 1 >

SetThrottle()

proto external void VehicleWheeledSimulation.SetThrottle

(

float

in

)

Sets throttle input.

Parameters

in	should be in range < 0, 1 >

WheelCount()

proto external int VehicleWheeledSimulation.WheelCount

(

)

Returns number of wheels.

WheelGetContactEntity()

proto external IEntity VehicleWheeledSimulation.WheelGetContactEntity

(

int

wheelIdx

)

Returns entity which is in contact with wheel.

WheelGetContactLiquidMaterial()

proto external GameMaterial VehicleWheeledSimulation.WheelGetContactLiquidMaterial

(

int

wheelIdx

)

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

WheelGetContactLiquidPosition()

proto external vector VehicleWheeledSimulation.WheelGetContactLiquidPosition

(

int

wheelIdx

)

Returns the position where the wheel touches a liquid surface.

WheelGetContactLiquidState()

proto external EWheelContactLiquidState VehicleWheeledSimulation.WheelGetContactLiquidState

(

int

wheelIdx

)

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

WheelGetContactMaterial()

proto external GameMaterial VehicleWheeledSimulation.WheelGetContactMaterial

(

int

wheelIdx

)

Returns wheel contact material.

WheelGetContactNormal()

proto external vector VehicleWheeledSimulation.WheelGetContactNormal

(

int

wheelIdx

)

Returns wheel contact normal.

WheelGetContactPosition()

proto external vector VehicleWheeledSimulation.WheelGetContactPosition

(

int

wheelIdx

)

Returns wheel contact position in world space.

WheelGetIndex()

proto external int VehicleWheeledSimulation.WheelGetIndex

(

string

name

)

Returns stored index of the wheel based on its name.

WheelGetLateralSlip()

proto external float VehicleWheeledSimulation.WheelGetLateralSlip

(

int

wheelIdx

)

Returns lateral slip of tyre.

WheelGetLongitudinalSlip()

proto external float VehicleWheeledSimulation.WheelGetLongitudinalSlip

(

int

wheelIdx

)

Returns longitudinal slip of tyre.

WheelGetMass()

proto external float VehicleWheeledSimulation.WheelGetMass

(

int

wheelIdx

)

Returns initial wheel's mass.

WheelGetMassState()

proto external float VehicleWheeledSimulation.WheelGetMassState

(

int

wheelIdx

)

Returns current wheel's mass.

WheelGetName()

proto external string VehicleWheeledSimulation.WheelGetName

(

int

wheelIdx

)

Returns name of the wheel based on its index.

WheelGetPosition()

proto external vector VehicleWheeledSimulation.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 VehicleWheeledSimulation.WheelGetRadius

(

int

wheelIdx

)

Returns initial wheel's radius.

WheelGetRadiusState()

proto external float VehicleWheeledSimulation.WheelGetRadiusState

(

int

wheelIdx

)

Returns current wheel's radius.

WheelGetRollingDrag()

proto external float VehicleWheeledSimulation.WheelGetRollingDrag

(

int

wheelIdx

)

Returns current wheel's rolling drag percentage.

WheelGetRPM()

proto external float VehicleWheeledSimulation.WheelGetRPM

(

int

wheelIdx

)

Returns current wheel's RPM.

WheelHasContact()

proto external bool VehicleWheeledSimulation.WheelHasContact

(

int

wheelIdx

)

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

WheelSetMassState()

proto external float VehicleWheeledSimulation.WheelSetMassState	(	int	wheelIdx,
		float	mass
	)

Sets current wheel's mass.

WheelSetRadiusState()

proto external float VehicleWheeledSimulation.WheelSetRadiusState	(	int	wheelIdx,
		float	radius
	)

Sets current wheel's radius.

WheelSetRollingDrag()

proto external void VehicleWheeledSimulation.WheelSetRollingDrag	(	int	wheelIdx,
		float	drag
	)

Sets current rolling drag percentage.

WheelTyreGetLateralFriction()

proto external float VehicleWheeledSimulation.WheelTyreGetLateralFriction

(

int

wheelIdx

)

Returns tyre's initial lateral friction.

WheelTyreGetLateralFrictionState()

proto external float VehicleWheeledSimulation.WheelTyreGetLateralFrictionState

(

int

wheelIdx

)

Returns tyre's current lateral friction.

WheelTyreGetLongitudinalFriction()

proto external float VehicleWheeledSimulation.WheelTyreGetLongitudinalFriction

(

int

wheelIdx

)

Returns tyre's initial longitudinal friction.

WheelTyreGetLongitudinalFrictionState()

proto external float VehicleWheeledSimulation.WheelTyreGetLongitudinalFrictionState

(

int

wheelIdx

)

Returns tyre's current longitudinal friction.

WheelTyreGetRoughness()

proto external float VehicleWheeledSimulation.WheelTyreGetRoughness

(

int

wheelIdx

)

Returns initial roughness of wheel's tyre surface.

WheelTyreGetRoughnessState()

proto external float VehicleWheeledSimulation.WheelTyreGetRoughnessState

(

int

wheelIdx

)

Returns current roughness of wheel's tyre surface.

WheelTyreSetLateralFrictionState()

proto external void VehicleWheeledSimulation.WheelTyreSetLateralFrictionState	(	int	wheelIdx,
		float	latFriction
	)

Sets tyre's current lateral friction.

WheelTyreSetLongitudinalFrictionState()

proto external void VehicleWheeledSimulation.WheelTyreSetLongitudinalFrictionState	(	int	wheelIdx,
		float	lngFriction
	)

Sets tyre's current longitudinal friction.

WheelTyreSetRoughnessState()

proto external void VehicleWheeledSimulation.WheelTyreSetRoughnessState	(	int	wheelIdx,
		float	roughness
	)

Sets current roughness of wheel's tyre surface.

---

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

• Game/generated/Vehicle/VehicleWheeledSimulation.c