Navigation
API > API/Plugins > API/Plugins/ChaosVehicles
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UChaosVehicleWheel
References
| Module | ChaosVehicles |
| Header | /Engine/Plugins/Experimental/ChaosVehiclesPlugin/Source/ChaosVehicles/Public/ChaosVehicleWheel.h |
| Include | #include "ChaosVehicleWheel.h" |
Syntax
UCLASS&40;BlueprintType, Blueprintable&41;
class UChaosVehicleWheel : public UObject
Variables
| Type | Name | Description | |
|---|---|---|---|
| EAxleType | AxleType | If left undefined then the bAffectedByEngine value is used, if defined then bAffectedByEngine is ignored and the differential setup on the vehicle defines which wheels get power from the engine | |
| bool | bABSEnabled | Advanced Braking System Enabled | |
| bool | bAffectedByBrake | Whether brake should affect this wheel | |
| bool | bAffectedByEngine | Whether engine should power this wheel | |
| bool | bAffectedByHandbrake | Whether handbrake should affect this wheel | |
| bool | bAffectedBySteering | Whether steering should affect this wheel | |
| bool | bTractionControlEnabled | Straight Line Traction Control Enabled | |
| TObjectPtr< class UStaticMesh > | CollisionMesh | Static mesh with collision setup for wheel, will be used to create wheel shape (if empty, sphere will be added as wheel shape, check bDontCreateShape flag) | |
| float | CorneringStiffness | Tyre Cornering Ability | |
| float | DebugLatForce | Lateral force the wheel is applying to the chassis. | |
| float | DebugLatSlip | Lateral slip experienced by the wheel. | |
| float | DebugLongForce | Longitudinal force the wheel is applying to the chassis. | |
| float | DebugLongSlip | Longitudinal slip experienced by the wheel. | |
| float | DebugNormalizedTireLoad | How much force the tire experiences at rest divided by how much force it is experiencing now. | |
| float | DebugTireLoad | How much force the tire is experiencing now. | |
| float | DebugWheelTorque | Wheel torque. | |
| ETorqueCombineMethod | ExternalTorqueCombineMethod | Determines how the SetDriveTorque/SetBrakeTorque inputs are combined with the internal torques | |
| float | FrictionForceMultiplier | Friction Force Multiplier | |
| FRuntimeFloatCurve | LateralSlipGraph | ||
| FVector | Location | Worldspace location of this wheel. | |
| float | MaxBrakeTorque | Max brake torque for this wheel (Nm) | |
| float | MaxHandBrakeTorque | Max handbrake brake torque for this wheel (Nm). | |
| float | MaxSteerAngle | Steer angle in degrees for this wheel | |
| float | MaxWheelspinRotation | Max Wheelspin rotation rad/sec | |
| const FObjectInitializer & | ObjectInitializer | ||
| FVector | Offset | If BoneName is specified, offset the wheel from the bone's location. | |
| FVector | OldLocation | Worldspace location of this wheel last frame. | |
| float | RollbarScaling | Anti-roll effect | |
| float | SideSlipModifier | Wheel Lateral Skid Grip Loss, lower number less grip on skid | |
| float | SkidThreshold | Wheel Lateral Skid Threshold | |
| float | SlipThreshold | Wheel Longitudinal Slip Threshold | |
| float | SpringPreload | Spring Preload (N/m) | |
| float | SpringRate | Spring Force (N/m) | |
| FVector | SuspensionAxis | Local body direction in which where suspension forces are applied (typically along -Z-axis) | |
| float | SuspensionDampingRatio | Suspension damping, larger value causes the suspension to come to rest faster [range 0 to 1] | |
| FVector | SuspensionForceOffset | Vertical offset from where suspension forces are applied (along Z-axis) | |
| float | SuspensionMaxDrop | How far the wheel can drop below the resting position | |
| float | SuspensionMaxRaise | How far the wheel can go above the resting position | |
| int | SuspensionSmoothing | Smooth suspension [0-off, 10-max] - Warning might cause momentary visual inter-penetration of the wheel against objects/terrain | |
| ESweepShape | SweepShape | Wheel suspension trace type, defaults to ray trace | |
| ESweepType | SweepType | Whether wheel suspension considers simple, complex | |
| UChaosWheeledVehicleMovementComponent | |||
| TObjectPtr< class UChaosWheeledVehicleMovementComponent > | VehicleComponent | The vehicle that owns us | |
| FVector | Velocity | Current velocity of the wheel center (change in location over time) | |
| int32 | WheelIndex | Our index in the vehicle's (and setup's) wheels array. | |
| float | WheelLoadRatio | Amount wheel load effects wheel friction. | |
| float | WheelMass | Mass of the wheel Kg | |
| float | WheelRadius | Radius of the wheel | |
| float | WheelWidth | Width of the wheel |
Functions
| Type | Name | Description | |
|---|---|---|---|
| EAxleType | GetAxleType () |
||
| UPhysicalMaterial * | Get contact surface material | ||
| FVector | Get the wheel's location in physics land | ||
| const Chaos::FSimpleSuspensionConfig & | |||
| const Chaos::FSimpleWheelConfig & | |||
| float | |||
| float | |||
| float | |||
| FVector | |||
| float | |||
| float | |||
| float | |||
| FChaosWheelSetup & | Get the Axle setup we were created from | ||
| void | Init
(
UChaosWheeledVehicleMovementComponent* InVehicleSim, |
Initialize this wheel instance | |
| bool | IsInAir () |
||
| void | Shutdown () |
Notify this wheel it will be removed from the scene | |
| void | Tick
(
float DeltaTime |
Tick this class when the vehicle ticks |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Respond to a property change in editor |