Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ChaosVehicles > UChaosVehicleMovementComponent

Light Theme

Dark Theme

UChaosVehicleMovementComponent

Base component to handle the vehicle simulation for an actor.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UMovementComponent

UNavMovementComponent

UPawnMovementComponent

UChaosVehicleMovementComponent

UChaosWheeledVehicleMovementComponent

References

Module	ChaosVehicles
Header	/Engine/Plugins/Experimental/ChaosVehiclesPlugin/Source/ChaosVehicles/Public/ChaosVehicleMovementComponent.h
Include	#include "ChaosVehicleMovementComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract,
HideCategories=(PlanarMovement, "Components|Movement|Planar", Activation, "Components|Activation"))
class UChaosVehicleMovementComponent : public UPawnMovementComponent

Remarks

Base component to handle the vehicle simulation for an actor.

Variables

	Name	Description
TArray< FVehicl...	Aerofoils	Optional aerofoil setup - can be used for car spoilers or aircraft wings/elevator/rudder
float	AngErrorAccumulator	Accumulator for RB replication errors
float	BrakeInput	Brake output to physics system. Range 0...1.
FVehicleInputRa...	BrakeInputRate	Rate at which input brake can rise and fall.
uint8: 1	bRawGearDownInput	True if the player is holding gear down.
uint8: 1	bRawGearUpInput	True if the player is holding gear up.
uint8: 1	bRawHandbrakeInput	True if the player is holding the handbrake.
uint8: 1	bReverseAsBrake	If true, the brake and reverse controls will behave in a more arcade fashion where holding reverse also functions as brake.
uint32: 1	bWasAvoidanceUpdated	Was avoidance updated in this frame?
float	ChassisHeight	Chassis height used for drag force computation (cm)
float	ChassisWidth	Chassis width used for drag force computation (cm)
float	DebugDragMagnitude	Debug drag magnitude last applied.
float	DownforceCoefficient	DownforceCoefficient of the vehicle chassis - force pressing vehicle into ground at speed
float	DragArea	Drag area in Meters^2.
float	DragCoefficient	DragCoefficient of the vehicle chassis - force resisting forward motion at speed
float	HandbrakeInput	Handbrake output to physics system. Range 0...1.
FVehicleInputRa...	HandbrakeInputRate	Rate at which input handbrake can rise and fall.
float	IdleBrakeInput	How much to press the brake when the player has release throttle.
FVector	InertiaTensorScale	Scales the vehicle's inertia in each direction (forward, right, up)
float	Mass	Mass to set the vehicle chassis to.
FDelegateHandle	MeshOnPhysicsStateChangeHandle	Handle for delegate registered on mesh component
float	PitchInput	Body Pitch output to physics system. Range -1...1.
FVehicleInputRa...	PitchInputRate	Rate at which input pitch can rise and fall.
TUniquePtr< Cha...	PVehicle	#todo: this isn't very configurable
float	RawBrakeInput	What the player has the brake set to. Range -1...1.
float	RawPitchInput	What the player has the pitch set to. Range -1...1.
float	RawRollInput	What the player has the roll set to. Range -1...1.
float	RawSteeringInput	What the player has the steering set to. Range -1...1.
float	RawThrottleInput	What the player has the accelerator set to. Range -1...1.
float	RawYawInput	What the player has the yaw set to. Range -1...1.
FVehicleReplica...	ReplicatedState	Replicated state of vehicle
float	RollInput	Body Roll output to physics system. Range -1...1.
FVehicleInputRa...	RollInputRate	Rate at which input roll can rise and fall.
float	SleepSlopeLimit	Option to apply some aggressive sleep logic if slopes up Z is less than this value, i.e value = Cos(SlopeAngle) so 0.866 will sleep up to 30 degree slopes
float	SleepThreshold	Option to apply some aggressive sleep logic, larger number is more agressive, 0 disables
FVehicleStabili...	StabilizeControl	Arcade style control of vehicle
float	SteeringInput	Steering output to physics system. Range -1...1.
FVehicleInputRa...	SteeringInputRate	Rate at which input steering can rise and fall.
float	StopThreshold	Auto-brake when absolute vehicle forward speed is less than this (cm/s)
FVehicleTargetR...	TargetRotationControl	Arcade style direct control of vehicle rotation via torque force
float	ThrottleInput	Accelerator output to physics system. Range 0...1.
FVehicleInputRa...	ThrottleInputRate	Rate at which input throttle can rise and fall.
TArray< FVehicl...	Thrusters	Optional thruster setup, use one or more as your main engine or as supplementary booster
FVehicleTorqueC...	TorqueControl	Arcade style direct control of vehicle rotation via torque force
uint32	VehicleSetupTag	Used to recreate the physics if the blueprint changes.
FVehicleState	VehicleState
float	WrongDirectionThreshold	Auto-brake when vehicle forward speed is opposite of player input by at least this much (cm/s)
float	YawInput	Body Yaw output to physics system. Range -1...1.
FVehicleInputRa...	YawInputRate	Rate at which input yaw can rise and fall.

Constructors

	Name	Description
	UChaosVehicleMovementComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddForce ( const FVector& Force, bool bAllowSubstepping, bool bAccelChange )	Add a force to this vehicle
void	AddForceAtPosition ( const FVector& Force, const FVector& Position, bool bAllowSubstepping, bool bIsLocalForce )	Add a force at a particular position (world space when bIsLocalForce = false, body space otherwise)
void	AddImpulse ( const FVector& Impulse, bool bVelChange )	Add an impulse to this vehicle
void	AddImpulseAtPosition ( const FVector& Impulse, const FVector& Position )	Add an impulse to this vehicle and a particular world position
void	AddTorqueInRadians ( const FVector& Torque, bool bAllowSubstepping, bool bAccelChange )	Add a torque to this vehicle
void	ApplyAerodynamics ( float DeltaTime )	Apply aerodynamic forces to vehicle body
void	ApplyAerofoilForces ( float DeltaTime )	Apply Aerofoil forces to vehicle body
void	ApplyInput ( float DeltaTime )	Pass control Input to the vehicle systems
void	ApplyThrustForces ( float DeltaTime )	Apply Thruster forces to vehicle body
void	ApplyTorqueControl ( float DeltaTime )	Apply direct control over vehicle body rotation
float	CalcBrakeInput()	Compute brake input
float	CalcHandbrakeInput()	Compute handbrake input
float	CalcPitchInput()	Compute pitch input
float	CalcRollInput()	Compute roll input
float	CalcSteeringInput()	Compute steering input
float	CalcThrottleDownInput()
float	CalcThrottleInput()	Compute throttle inputs
float	CalcThrottleUpInput()
float	CalcYawInput()	Compute yaw input
bool	CanCreateVehicle()	Return true if we are ready to create a vehicle, false if the setup has missing references
bool	CanSimulate()	Are enough vehicle systems specified such that physics vehicle simulation is possible
void	ClearAllInput()
void	ClearInput()	Clear all interpolated inputs to default values.
void	ClearRawInput()	Clear all raw inputs to default values.
void	ComputeConstants()	When vehicle is created we want to compute some helper data like drag area, etc....
void	CreatePhysicsVehicle()
void	CreateVehicle()	Create and setup the Chaos vehicle
void	DecreaseThrottleInput ( float ThrottleDelta )	Decrease the vehicle throttle position [throttle range normalized 0 to 1]
void	DrawDebug ( UCanvas* Canvas, float& YL, float& YPos )	Draw debug text for the wheels and suspension
void	DrawDebug3D()	Draw debug text for the wheels and suspension
void	DrawLine2D ( UCanvas* Canvas, const FVector2D& StartPos, const FVector2D& EndPos, FColor Color, float Thickness )	Draw 2D debug line to UI canvas
void	EnableSelfRighting ( bool InState )
void	FixupSkeletalMesh()	Skeletal mesh needs some special handling in the vehicle case
FBodyInstanc...	GetBodyInstance()
AController ...	GetController()	Get our controller
int32	GetCurrentGear()	Get current gear
float	GetForwardAcceleration()
float	GetForwardSpeed()	How fast the vehicle is moving forward
float	GetForwardSpeedMPH()	How fast the vehicle is moving forward
UMeshCompone...	GetMesh()	Get the mesh this vehicle is tied to
USkeletalMes...	GetSkeletalMesh()	Get Mesh cast as USkeletalMeshComponent, may return null if cast fails
UStaticMeshC...	GetStaticMesh()	Get Mesh cast as UStaticMeshComponent, may return null if cast fails
int32	GetTargetGear()	Get target gear
bool	GetUseAutoGears()	Are gears being changed automatically?
void	IncreaseThrottleInput ( float ThrottleDelta )	Increase the vehicle throttle position [throttle range normalized 0 to 1]
FVector	LocateBoneOffset ( const FName InBoneName, const FVector& InExtraOffset )	Location local coordinates of named bone in skeleton, apply additional offset or just use offset if no bone located
TUniquePtr< ...	PhysicsVehicle()
void	PostSetupVehicle()	Do some final setup after the Chaos vehicle gets created
void	PreTick ( float DeltaTime )	Updates the vehicle tuning and other state such as user input.
void	ProcessSleeping()	Option to aggressively sleep the vehicle
void	ServerUpdateState ( float InSteeringInput, float InThrottleInput, float InBrakeInput, float InHandbrakeInput, int32 InCurrentGear, float InRollInput, float InPitchInput, float InYawInput )	Pass current state to server
void	SetBrakeInput ( float Brake )	Set the user input for the vehicle Brake [range 0 to 1]
void	SetChangeDownInput ( bool bNewGearDown )	Set the user input for gear down
void	SetChangeUpInput ( bool bNewGearUp )	Set the user input for gear up
void	SetHandbrakeInput ( bool bNewHandbrake )	Set the user input for handbrake
void	SetOverrideController ( AController* OverrideControlle... )	Allow the player controller of a different pawn to control this vehicle
void	SetPitchInput ( float Pitch )	Set the user input for the vehicle pitch [range -1 to 1]
void	SetRollInput ( float Roll )	Set the user input for the vehicle roll [range -1 to 1]
void	SetSteeringInput ( float Steering )	Set the user input for the vehicle steering [range -1 to 1]
void	SetTargetGear ( int32 GearNum, bool bImmediate )	Set the user input for gear (-1 reverse, 0 neutral, 1+ forward)
void	SetThrottleInput ( float Throttle )	Set the user input for the vehicle throttle [range 0 to 1]
void	SetupVehicle()	Allocate and setup the Chaos vehicle
void	SetupVehicleMass()	Adjust the Chaos Physics mass
void	SetUseAutomaticGears ( bool bUseAuto )	Set the flag that will be used to select auto-gears
void	SetYawInput ( float Yaw )	Set the user input for the vehicle yaw [range -1 to 1]
void	ShowDebugInfo ( AHUD* HUD, UCanvas* Canvas, const FDebugDisplayInfo& DisplayIn..., float& YL, float& YPos )
void	TickVehicle ( float DeltaTime )	Tick this vehicle sim right before input is sent to the vehicle system
void	UpdateMassProperties ( FBodyInstance* BI )
void	UpdateSimulation ( float DeltaTime )	Advance the vehicle simulation
void	UpdateState ( float DeltaTime )	Read current state for simulation

Overridden from UMovementComponent

		Name	Description
	void	SetUpdatedComponent ( USceneComponent* NewUpdatedCom... )	Overridden to allow registration with components NOT owned by a Pawn.
	void	StopMovementImmediately()	Stops movement immediately (zeroes velocity, usually zeros acceleration for components with acceleration).

Overridden from UActorComponent

	Name	Description
bool	HasValidPhysicsState()	Returns true if the physics state exists
void	OnCreatePhysicsState()	Used to create any physics engine information for this component
void	OnDestroyPhysicsState()	Used to shut down and physics engine structure for this component
bool	ShouldCreatePhysicsState()	Return true if it's suitable to create a physics representation of the vehicle at this time

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	End UObject interface Respond to a property change in editor
	void	Serialize ( FArchive& Ar )	UObject interface

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss