Differences

This shows you the differences between two versions of the page.

--- scripting:components:wheeledsimulation [2022/08/09 23:45] – [WheelGetContactMaterial(int wheelIdx);] jerryhopper
+++ scripting:components:wheeledsimulation [2022/08/10 00:24] (current) – [Common usage] jerryhopper
@@ Line 4: / Line 4: @@
 Provides functionality for wheeled vehicles.
-**class:** VehicleWheeledSimulation: VehicleBaseSimulation
+**class:** VehicleWheeledSimulation
+**Parent Class:** VehicleBaseSimulation
 **Location:** scripts/Game/generated/Vehicle/VehicleWheeledSimulation.c
@@ Line 11: / Line 13: @@
 ---
+===== Common usage =====
+wip
 ===== Functions =====
@@ Line 136: / Line 145: @@
 Return Type: [[scripting:datatypes#bool]]
-==== EngineGetRPMIdle(); ====
+==== EngineGetRPMIdle() ====
+  EngineGetRPMIdle();
 Returns idle rpm of the engine
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetRPMPeakTorque(); ====
+==== EngineGetRPMPeakTorque() ====
+  EngineGetRPMPeakTorque();
 Returns rpm at which engine provides maximal torque
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetRPMPeakPower(); ====
+==== EngineGetRPMPeakPower() ====
+  EngineGetRPMPeakPower();
 Returns rpm at which engine provides maximal power
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetRPMMax(); ====
+==== EngineGetRPMMax() ====
+  EngineGetRPMMax();
 Returns maximal working rpm before engine explodes
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetRPM(); ====
+==== EngineGetRPM() ====
+  EngineGetRPM();
 Returns current engine's RPM
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetRPMFeedback(); ====
+==== EngineGetRPMFeedback() ====
+  EngineGetRPMFeedback();
 Returns RPM that is feeded back from rest of the powertrain
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetLoad(); ====
+==== EngineGetLoad() ====
+  EngineGetLoad();
 Returns current engine load in range < 0, 1 >
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetPeakTorque(); ====
+==== EngineGetPeakTorque() ====
+  EngineGetPeakTorque();
 Returns initial engine's peak torque in Nm (newton-metre).
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetPeakTorqueState(); ====
+==== EngineGetPeakTorqueState() ====
+  EngineGetPeakTorqueState();
 Returns current engine's peak torque in Nm (newton-metre).
 Return Type: [[scripting:datatypes#float]]
-==== EngineSetPeakTorqueState(float peakTorque); ====
+==== EngineSetPeakTorqueState() ====
+  EngineSetPeakTorqueState(float peakTorque);
 Sets current engine's peak torque.
 \param peakTorque must be in Nm (newton-metre).
@@ Line 187: / Line 217: @@
 Return Type: [[scripting:datatypes#void]]
-==== EngineGetPeakPower(); ====
+==== EngineGetPeakPower() ====
+  EngineGetPeakPower();
 Returns initial engine's peak power in kW (kilowatts).
 Return Type: [[scripting:datatypes#float]]
-==== EngineGetPeakPowerState(); ====
+==== EngineGetPeakPowerState() ====
+  EngineGetPeakPowerState();
 Returns current engine's peak power in kW (kilowatts).
 Return Type: [[scripting:datatypes#float]]
-==== EngineSetPeakPowerState(float peakPower); ====
+==== EngineSetPeakPowerState() ====
+  EngineSetPeakPowerState(float peakPower);
 Sets current engine's peak power.
 \param peakTorque must be in kW (kilowatts).
@@ Line 203: / Line 241: @@
 Return Type: [[scripting:datatypes#float]]
-==== GearboxGetEfficiency(); ====
+==== GearboxGetEfficiency() ====
+  GearboxGetEfficiency();
 Returns initial gearbox efficiency.
 Return Type: [[scripting:datatypes#float]]
-==== GearboxGetEfficiencyState(); ====
+==== GearboxGetEfficiencyState() ====
+  GearboxGetEfficiencyState();
 Returns current gearbox efficiency.
 Return Type: [[scripting:datatypes#float]]
-==== GearboxSetEfficiencyState(float efficiency); ====
+==== GearboxSetEfficiencyState() ====
+  GearboxSetEfficiencyState(float efficiency);
 Sets current gearbox efficiency.
 Return Type: [[scripting:datatypes#void]]
-==== GearboxGearsCount(); ====
+==== GearboxGearsCount() ====
+  GearboxGearsCount();
 Returns number of all gear ratios (neutral included).
 Return Type: [[scripting:datatypes#int]]
-==== GearboxForwardGearsCount(); ====
+==== GearboxForwardGearsCount() ====
+  GearboxForwardGearsCount();
 Returns number of forward gears.
 Return Type: [[scripting:datatypes#int]]
-==== WheelCount(); ====
+==== WheelCount() ====
+  WheelCount();
 Returns number of wheels
 Return Type: [[scripting:datatypes#int]]
-==== WheelGetIndex(string name); ====
+==== WheelGetIndex() ====
+  WheelGetIndex(string name);
 Returns stored index of the wheel based on its name
@@ Line 241: / Line 300: @@
-==== WheelGetPosition(int wheelIdx, float displacement = 0.0); ====
+==== WheelGetPosition() ====
-/*!
+  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: [[scripting:datatypes#vector]]
-==== WheelGetName(int wheelIdx); ====
+==== WheelGetName() ====
+  WheelGetName(int wheelIdx);
 Returns name of the wheel based on its index
 Return Type: string
-==== WheelHasContact(int wheelIdx); ====
+==== WheelHasContact() ====
+  WheelHasContact(int wheelIdx);
 Returns true if wheel has contact with ground or other object