VehiceWheeledSimulation

Provides functionality for wheeled vehicles.

class: VehicleWheeledSimulation

Parent Class: VehicleBaseSimulation

Location: scripts/Game/generated/Vehicle/VehicleWheeledSimulation.c

—

wip

GetSpeedKmh();

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

Return Type: float

GetSteering();

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

Return Type: float

SetSteering(float in);

Sets steering input. \param in should be in range < -1, 1 >

Return Type: void

GetClutch();

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

Return Type: float

SetClutch(float in);

Sets the clutch input \param in should be in range < 0, 1 >

Return Type: void

GetBrake();

Returns current brake input in range < 0, 1 >

Return Type: float

SetBreak(float in, bool hb);

Sets brake inputs \param in should be in range < 0, 1 > \param hb indicating whether handbrake should be applied

Return Type: void

GetThrottle();

returns current throttle input in range < 0, 1 >

Return Type: float

SetThrottle(float in);

Sets throttle input \param in should be in range < 0, 1 >

Return Type: void

GetGear();

Returns index of currently engaged gear

Return Type: int

SetGear(int in);

Switches to given gear

Return Type: void

IsHandbrakeOn();

Returns whether handbrake is currently applied

Return Type: bool

EngineStart();

Starts the engine

Return Type: void

EngineStop();

Stops the engine

Return Type: void

EngineIsOn();

Returns true if engine is running

Return Type: bool

EngineGetRPMIdle();

Returns idle rpm of the engine

Return Type: float

EngineGetRPMPeakTorque(); 

Returns rpm at which engine provides maximal torque

Return Type: float

EngineGetRPMPeakPower(); 

Returns rpm at which engine provides maximal power

Return Type: float

EngineGetRPMMax(); 

Returns maximal working rpm before engine explodes

Return Type: float

EngineGetRPM(); 

Returns current engine's RPM

Return Type: float

EngineGetRPMFeedback();

Returns RPM that is feeded back from rest of the powertrain

Return Type: float

EngineGetLoad();

Returns current engine load in range < 0, 1 >

Return Type: float

EngineGetPeakTorque();

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

Return Type: float

EngineGetPeakTorqueState();

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

Return Type: float

EngineSetPeakTorqueState(float peakTorque);

Sets current engine's peak torque. \param peakTorque must be in Nm (newton-metre).

Return Type: void

EngineGetPeakPower();

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

Return Type: float

EngineGetPeakPowerState();

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

Return Type: float

EngineSetPeakPowerState(float peakPower);

Sets current engine's peak power. \param peakTorque must be in kW (kilowatts).

Return Type: float

GearboxGetEfficiency();

Returns initial gearbox efficiency.

Return Type: float

GearboxGetEfficiencyState();

Returns current gearbox efficiency.

Return Type: float

GearboxSetEfficiencyState(float efficiency);

Sets current gearbox efficiency.

Return Type: void

GearboxGearsCount();

Returns number of all gear ratios (neutral included).

Return Type: int

GearboxForwardGearsCount();

Returns number of forward gears.

Return Type: int

WheelCount();

Returns number of wheels

Return Type: int

WheelGetIndex(string name);

Returns stored index of the wheel based on its name

Return Type: int

WheelGetPosition(int wheelIdx, float displacement = 0.0);

Get the wheel position based on suspension. \param wheelIdx Index of the wheel \param displacement 0 means the position of the wheel when the suspension is fully extended ( zero g ). \return Returns wheel position in local space.

Return Type: vector

WheelGetName(int wheelIdx);

Returns name of the wheel based on its index

Return Type: string

WheelHasContact(int wheelIdx);

Returns true if wheel has contact with ground or other object

Return Type: bool

WheelGetContactMaterial(int wheelIdx);

Returns wheel contact material

Return Type: GameMaterial

WheelGetContactPosition(int wheelIdx);

Returns wheel contact position in world space

Return Type: vector

WheelGetContactNormal(int wheelIdx);

Returns wheel contact normal

Return Type: vector

WheelGetContactEntity(int wheelIdx); 

Returns entity which is in contact with wheel

Return Type: IEntity

WheelGetRPM(int wheelIdx);

Returns current wheel's RPM

Return Type: float

WheelGetRadius(int wheelIdx);

Returns initial wheel's radius

Return Type: float

WheelGetRadiusState(int wheelIdx);

Returns current wheel's radius

Return Type: float

WheelSetRadiusState(int wheelIdx, float radius);

Sets current wheel's radius

Return Type: float

WheelGetMass(int wheelIdx); 

Returns initial wheel's mass

Return Type: float

WheelGetMassState(int wheelIdx);

Returns current wheel's mass

Return Type: float

WheelSetMassState(int wheelIdx, float mass);

Sets current wheel's mass

Return Type: float

WheelGetLongitudinalSlip(int wheelIdx);

Returns longitudinal slip of tyre

Return Type: float

WheelGetLateralSlip(int wheelIdx);

Returns lateral slip of tyre

Return Type: float

WheelGetRollingDrag(int wheelIdx);

Returns current wheel's rolling drag percentage

Return Type: float

WheelSetRollingDrag(int wheelIdx, float drag);

Sets current rolling drag percentage

Return Type: void

WheelTyreGetRoughness(int wheelIdx);

Returns initial roughness of wheel's tyre surface

Return Type: float

WheelTyreGetRoughnessState(int wheelIdx);

Returns current roughness of wheel's tyre surface

Return Type: float

WheelTyreSetRoughnessState(int wheelIdx, float roughness);

Sets current roughness of wheel's tyre surface

Return Type: void

WheelTyreGetLongitudinalFriction(int wheelIdx);

Returns tyre's initial longitudinal friction

Return Type: float

WheelTyreGetLongitudinalFrictionState(int wheelIdx);

Returns tyre's current longitudinal friction

Return Type: float

WheelTyreSetLongitudinalFrictionState(int wheelIdx, float lngFriction);

Sets tyre's current longitudinal friction

Return Type: void

WheelTyreGetLateralFriction(int wheelIdx);

Returns tyre's initial lateral friction

Return Type: float

WheelTyreGetLateralFrictionState(int wheelIdx);

Returns tyre's current lateral friction

Return Type: float

WheelTyreSetLateralFrictionState(int wheelIdx, float latFriction);

Sets tyre's current lateral friction

Return Type: void

GetNoiseSteerSensitivity();

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

Return Type: float

SetNoiseSteerSensitivity(float newValue);

Sets sensitivity on noise steer \param newValue should be in range < 0, 1 >

Return Type: void

GetRoughnessSensitivity();

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

Return Type: float

SetRoughnessSensitivity(float newValue);

Sets sensitivity on roughness value of surface \param newValue should be in range < 0, 1 >

Return Type: void