UChaosVehicleWheel

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ChaosVehicles

Header

/Engine/Plugins/Experimental/ChaosVehiclesPlugin/Source/ChaosVehicles/Public/ChaosVehicleWheel.h

Include

#include "ChaosVehicleWheel.h"

Syntax

UCLASS(BlueprintType, Blueprintable)
class UChaosVehicleWheel : public UObject

Variables

Name Description

Public variable UProperty Category, EditAnywhere

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

Public variable UProperty Category, EditAnywhere

bool

 

bABSEnabled

Advanced Braking System Enabled

Public variable UProperty Category, EditAnywhere

bool

 

bAffectedByBrake

Whether brake should affect this wheel

Public variable UProperty Category, EditAnywhere

bool

 

bAffectedByEngine

Whether engine should power this wheel

Public variable UProperty Category, EditAnywhere

bool

 

bAffectedByHandbrake

Whether handbrake should affect this wheel

Public variable UProperty Category, EditAnywhere

bool

 

bAffectedBySteering

Whether steering should affect this wheel

Public variable UProperty Category, EditAnywhere

bool

 

bTractionControlEnabled

Straight Line Traction Control Enabled

Public variable UProperty Category, EditAnywhere

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)

Public variable UProperty Category, EditAnywhere, Meta

float

 

CorneringStiffness

Tyre Cornering Ability

Public variable UProperty Transient

float

 

DebugLatForce

Lateral force the wheel is applying to the chassis.

Public variable UProperty Transient

float

 

DebugLatSlip

Lateral slip experienced by the wheel.

Public variable UProperty Transient

float

 

DebugLongForce

Longitudinal force the wheel is applying to the chassis.

Public variable UProperty Transient

float

 

DebugLongSlip

Longitudinal slip experienced by the wheel.

Public variable

float

 

DebugNormalizedTireLoad

How much force the tire experiences at rest divided by how much force it is experiencing now.

Public variable UProperty Transient

float

 

DebugTireLoad

How much force the tire is experiencing now.

Public variable UProperty Transient

float

 

DebugWheelTorque

Wheel torque.

Public variable UProperty Category, EditAnywhere, Meta

float

 

FrictionForceMultiplier

Friction Force Multiplier

Public variable

FHitResult

 

HitResult

Suspension raycast results

Public variable UProperty Category, EditAnywhere

FRuntimeFloatCu...

 

LateralSlipGraph

Public variable UProperty Transient

FVector

 

Location

Worldspace location of this wheel.

Public variable UProperty Category, EditAnywhere

float

 

MaxBrakeTorque

Max brake torque for this wheel (Nm)

Public variable UProperty Transient

float

 

MaxHandBrakeTorque

Max handbrake brake torque for this wheel (Nm).

Public variable UProperty Category, EditAnywhere

float

 

MaxSteerAngle

Steer angle in degrees for this wheel

Public variable UProperty Category, EditDefaultsOnly

const FObjectIn...

 

ObjectInitializer

Public variable UProperty Category, EditAnywhere, Meta

FVector

 

Offset

If BoneName is specified, offset the wheel from the bone's location.

Public variable UProperty Transient

FVector

 

OldLocation

Worldspace location of this wheel last frame.

Public variable UProperty Category, EditAnywhere

float

 

RollbarScaling

Anti-roll effect

Public variable UProperty Category, EditAnywhere, Meta

float

 

SideSlipModifier

Wheel Lateral Skid Grip Loss, lower number less grip on skid

Public variable UProperty Category, EditAnywhere

float

 

SkidThreshold

Wheel Lateral Skid Threshold

Public variable UProperty Category, EditAnywhere, Meta

float

 

SlipThreshold

Wheel Longitudinal Slip Threshold

Public variable UProperty Category, EditAnywhere, Meta

float

 

SpringPreload

Spring Preload (N/m)

Public variable UProperty Category, EditAnywhere

float

 

SpringRate

Spring Force (N/m)

Public variable UProperty Category, EditAnywhere

FVector

 

SuspensionAxis

Local body direction in which where suspension forces are applied (typically along -Z-axis)

Public variable UProperty Category, EditAnywhere, Meta

float

 

SuspensionDampingRatio

Suspension damping, larger value causes the suspension to come to rest faster [range 0 to 1]

Public variable UProperty Category, EditAnywhere

FVector

 

SuspensionForceOffset

Vertical offset from where suspension forces are applied (along Z-axis)

Public variable UProperty Category, EditAnywhere

float

 

SuspensionMaxDrop

How far the wheel can drop below the resting position

Public variable UProperty Category, EditAnywhere

float

 

SuspensionMaxRaise

How far the wheel can go above the resting position

Public variable UProperty Category, EditAnywhere, Meta

int

 

SuspensionSmoothing

Smooth suspension [0-off, 10-max] - Warning might cause momentary visual inter-penetration of the wheel against objects/terrain

Public variable UProperty Category, EditAnywhere

ESweepShape

 

SweepShape

Whether wheel suspension considers simple, complex, or both

Public variable UProperty Category, EditAnywhere

ESweepType

 

SweepType

Whether wheel suspension considers simple, complex, or both

Public variable

 

UChaosWheeledVehicleMovementComponent

Public variable UProperty Transient

UChaosWheeledVe...

 

VehicleComponent

The vehicle that owns us

Public variable

FVector

 

Velocity

Current velocity of the wheel center (change in location over time)

Public variable UProperty Transient

int32

 

WheelIndex

Our index in the vehicle's (and setup's) wheels array.

Public variable UProperty Category, EditAnywhere

float

 

WheelLoadRatio

Amount wheel load effects wheel friction.

Public variable UProperty Category, EditAnywhere, Meta

float

 

WheelRadius

Radius of the wheel

Public variable UProperty Category, EditAnywhere, Meta

float

 

WheelWidth

Width of the wheel

Functions

Name Description

Public function

EAxleType

 

GetAxleType()

Public function

UPhysicalMat...

 

GetContactSurfaceMaterial()

Get contact surface material

Protected function

FVector

 

GetPhysicsLocation()

Get the wheel's location in physics land

Public function

const Chaos:...

 

GetPhysicsSuspensionConfig()

Public function

const Chaos:...

 

GetPhysicsWheelConfig()

Public function Const UFunction BlueprintCallable, Category

float

 

GetRotationAngle()

Public function Const UFunction BlueprintCallable, Category

float

 

GetRotationAngularVelocity()

Public function Const UFunction BlueprintCallable, Category

float

 

GetSteerAngle()

Public function Const UFunction BlueprintCallable, Category

float

 

GetSuspensionOffset()

Public function Const UFunction BlueprintCallable, Category

float

 

GetWheelAngularVelocity()

Public function Const UFunction BlueprintCallable, Category

float

 

GetWheelRadius()

Public function

FChaosWheelS...

 

GetWheelSetup()

Get the Axle setup we were created from

Public function Virtual

void

 

Init

(
    UChaosWheeledVehicleMovementCompone...,
    int32 InWheelIndex
)

Initialize this wheel instance

Public function Const UFunction BlueprintCallable, Category

bool

 

IsInAir()

Public function Virtual

void

 

Shutdown()

Notify this wheel it will be removed from the scene

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

Tick this class when the vehicle ticks

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Respond to a property change in editor