Class WheeledVehicleMovementComponent

Component to handle the vehicle simulation for an actor.

Inheritance
System.Object
UObject
ActorComponent
MovementComponent
NavMovementComponent
PawnMovementComponent
WheeledVehicleMovementComponent
SimpleWheeledVehicleMovementComponent
WheeledVehicleMovementComponent4W
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.PhysXVehicles
Assembly: UE4DotNet.dll
Syntax
public class WheeledVehicleMovementComponent : PawnMovementComponent

Properties

| Improve this Doc View Source

AvoidanceConsiderationRadius

Area Radius to consider for RVO avoidance

Declaration
public float AvoidanceConsiderationRadius { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

AvoidanceGroup

Moving actor's group mask

Declaration
public NavAvoidanceMask AvoidanceGroup { get; }
Property Value
Type Description
NavAvoidanceMask
| Improve this Doc View Source

AvoidanceUID

No default value, for now it's assumed to be valid if GetAvoidanceManager() returns non-NULL.

Declaration
public int AvoidanceUID { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

AvoidanceWeight

De facto default value 0.5 (due to that being the default in the avoidance registration function), indicates RVO behavior.

Declaration
public float AvoidanceWeight { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

bDeprecatedSpringOffsetMode

Declaration
public bool bDeprecatedSpringOffsetMode { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BrakeInput

Brake output to physics system. Range 0...1

Declaration
public float BrakeInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

BrakeInputRate

Rate at which input brake can rise and fall

Declaration
public VehicleInputRate BrakeInputRate { get; set; }
Property Value
Type Description
VehicleInputRate
| Improve this Doc View Source

bRawGearDownInput

Declaration
public bool bRawGearDownInput { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bRawGearUpInput

Declaration
public bool bRawGearUpInput { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bRawHandbrakeInput

Declaration
public bool bRawHandbrakeInput { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bReverseAsBrake

Declaration
public bool bReverseAsBrake { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseRVOAvoidance

Declaration
public bool bUseRVOAvoidance { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bWasAvoidanceUpdated

Declaration
public bool bWasAvoidanceUpdated { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ChassisHeight

Chassis height used for drag force computation (cm)

Declaration
public float ChassisHeight { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ChassisWidth

Chassis width used for drag force computation (cm)

Declaration
public float ChassisWidth { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DebugDragMagnitude

Debug drag magnitude last applied

Declaration
public float DebugDragMagnitude { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static WheeledVehicleMovementComponent DefaultObject { get; }
Property Value
Type Description
WheeledVehicleMovementComponent
| Improve this Doc View Source

DragArea

Drag area in cm^2

Declaration
public float DragArea { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DragCoefficient

DragCoefficient of the vehicle chassis.

Declaration
public float DragCoefficient { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

EstimatedMaxEngineSpeed

Estimated mad speed for engine

Declaration
public float EstimatedMaxEngineSpeed { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

GroupsToAvoid

Will avoid other agents if they are in one of specified groups

Declaration
public NavAvoidanceMask GroupsToAvoid { get; }
Property Value
Type Description
NavAvoidanceMask
| Improve this Doc View Source

GroupsToIgnore

Will NOT avoid other agents if they are in one of specified groups, higher priority than GroupsToAvoid

Declaration
public NavAvoidanceMask GroupsToIgnore { get; }
Property Value
Type Description
NavAvoidanceMask
| Improve this Doc View Source

HandbrakeInput

Handbrake output to physics system. Range 0...1

Declaration
public float HandbrakeInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

HandbrakeInputRate

Rate at which input handbrake can rise and fall

Declaration
public VehicleInputRate HandbrakeInputRate { get; set; }
Property Value
Type Description
VehicleInputRate
| Improve this Doc View Source

HighForwardSpeedSubStepCount

The sub-step count above the threshold longitudinal speed has a default of 1.

Declaration
public int HighForwardSpeedSubStepCount { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

IdleBrakeInput

How much to press the brake when the player has release throttle

Declaration
public float IdleBrakeInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

InertiaTensorScale

Scales the vehicle's inertia in each direction (forward, right, up)

Declaration
public Vector InertiaTensorScale { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

LowForwardSpeedSubStepCount

The sub-step count below the threshold longitudinal speed has a default of 3.

Declaration
public int LowForwardSpeedSubStepCount { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

Mass

Mass to set the vehicle chassis to.

Declaration
public float Mass { get; set; }
Property Value
Type Description
System.Single
Remarks

It's much easier to tweak vehicle settings when the mass doesn't change due to tweaks with the physics asset. [kg]

| Improve this Doc View Source

MaxEngineRPM

Max RPM for engine

Declaration
public float MaxEngineRPM { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxNormalizedTireLoad

Clamp normalized tire load to this value

Declaration
public float MaxNormalizedTireLoad { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MaxNormalizedTireLoadFiltered

Clamp normalized tire load to this value

Declaration
public float MaxNormalizedTireLoadFiltered { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MinNormalizedTireLoad

Clamp normalized tire load to this value

Declaration
public float MinNormalizedTireLoad { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MinNormalizedTireLoadFiltered

Clamp normalized tire load to this value

Declaration
public float MinNormalizedTireLoadFiltered { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

OverrideController

Override Controller

Declaration
public Controller OverrideController { get; set; }
Property Value
Type Description
Controller
| Improve this Doc View Source

PendingLaunchVelocity

Temporarily holds launch velocity when pawn is to be launched so it happens at end of movement.

Declaration
public Vector PendingLaunchVelocity { get; set; }
Property Value
Type Description
Vector
| Improve this Doc View Source

RawBrakeInput

What the player has the brake set to. Range -1...1

Declaration
public float RawBrakeInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RawSteeringInput

What the player has the steering set to. Range -1...1

Declaration
public float RawSteeringInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RawThrottleInput

What the player has the accelerator set to. Range -1...1

Declaration
public float RawThrottleInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ReplicatedState

replicated state of vehicle

Declaration
public ReplicatedVehicleState ReplicatedState { get; set; }
Property Value
Type Description
ReplicatedVehicleState
| Improve this Doc View Source

RVOAvoidanceHeight

Vehicle Height to use for RVO avoidance (usually vehicle height)

Declaration
public float RVOAvoidanceHeight { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RVOAvoidanceRadius

Vehicle Radius to use for RVO avoidance (usually half of vehicle width)

Declaration
public float RVOAvoidanceRadius { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RVOSteeringStep

Value by which to alter steering per frame based on calculated avoidance

Declaration
public float RVOSteeringStep { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RVOThrottleStep

Value by which to alter throttle per frame based on calculated avoidance

Declaration
public float RVOThrottleStep { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

SteeringInput

Steering output to physics system. Range -1...1

Declaration
public float SteeringInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SteeringInputRate

Rate at which input steering can rise and fall

Declaration
public VehicleInputRate SteeringInputRate { get; set; }
Property Value
Type Description
VehicleInputRate
| Improve this Doc View Source

StopThreshold

Auto-brake when absolute vehicle forward speed is less than this (cm/s)

Declaration
public float StopThreshold { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ThresholdLongitudinalSpeed

PhysX sub-steps More sub-steps provides better stability but with greater computational cost.

Declaration
public float ThresholdLongitudinalSpeed { get; set; }
Property Value
Type Description
System.Single
Remarks

Typically, vehicles require more sub-steps at very low forward speeds. The threshold longitudinal speed has a default value of 5 metres per second.

| Improve this Doc View Source

ThrottleInput

Accelerator output to physics system. Range 0...1

Declaration
public float ThrottleInput { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

ThrottleInputRate

Rate at which input throttle can rise and fall

Declaration
public VehicleInputRate ThrottleInputRate { get; set; }
Property Value
Type Description
VehicleInputRate
| Improve this Doc View Source

Wheels

Our instanced wheels

Declaration
public ObjectArrayField<VehicleWheel> Wheels { get; }
Property Value
Type Description
ObjectArrayField<VehicleWheel>
| Improve this Doc View Source

WrongDirectionThreshold

Auto-brake when vehicle forward speed is opposite of player input by at least this much (cm/s)

Declaration
public float WrongDirectionThreshold { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

GetCurrentGear()

Get current gear

Declaration
public int GetCurrentGear()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetEngineMaxRotationSpeed()

Get current engine's max rotation speed

Declaration
public float GetEngineMaxRotationSpeed()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetEngineRotationSpeed()

Get current engine's rotation speed

Declaration
public float GetEngineRotationSpeed()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetForwardSpeed()

How fast the vehicle is moving forward

Declaration
public float GetForwardSpeed()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetTargetGear()

Get target gear

Declaration
public int GetTargetGear()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetUseAutoGears()

Are gears being changed automatically?

Declaration
public bool GetUseAutoGears()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static WheeledVehicleMovementComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
WheeledVehicleMovementComponent
| Improve this Doc View Source

SetAvoidanceEnabled(Boolean)

Change avoidance state and register with RVO manager if necessary

Declaration
public void SetAvoidanceEnabled(bool bEnable)
Parameters
Type Name Description
System.Boolean bEnable
| Improve this Doc View Source

SetAvoidanceGroup(Int32)

Set Avoidance Group

Declaration
public void SetAvoidanceGroup(int GroupFlags)
Parameters
Type Name Description
System.Int32 GroupFlags
| Improve this Doc View Source

SetAvoidanceGroupMask(NavAvoidanceMask)

Set Avoidance Group Mask

Declaration
public void SetAvoidanceGroupMask(NavAvoidanceMask GroupMask)
Parameters
Type Name Description
NavAvoidanceMask GroupMask
| Improve this Doc View Source

SetBrakeInput(Single)

Set the user input for the vehicle Brake

Declaration
public void SetBrakeInput(float Brake)
Parameters
Type Name Description
System.Single Brake
| Improve this Doc View Source

SetGearDown(Boolean)

Set the user input for gear down

Declaration
public void SetGearDown(bool bNewGearDown)
Parameters
Type Name Description
System.Boolean bNewGearDown
| Improve this Doc View Source

SetGearUp(Boolean)

Set the user input for gear up

Declaration
public void SetGearUp(bool bNewGearUp)
Parameters
Type Name Description
System.Boolean bNewGearUp
| Improve this Doc View Source

SetGroupsToAvoid(Int32)

Set Groups to Avoid

Declaration
public void SetGroupsToAvoid(int GroupFlags)
Parameters
Type Name Description
System.Int32 GroupFlags
| Improve this Doc View Source

SetGroupsToAvoidMask(NavAvoidanceMask)

Set Groups to Avoid Mask

Declaration
public void SetGroupsToAvoidMask(NavAvoidanceMask GroupMask)
Parameters
Type Name Description
NavAvoidanceMask GroupMask
| Improve this Doc View Source

SetGroupsToIgnore(Int32)

Set Groups to Ignore

Declaration
public void SetGroupsToIgnore(int GroupFlags)
Parameters
Type Name Description
System.Int32 GroupFlags
| Improve this Doc View Source

SetGroupsToIgnoreMask(NavAvoidanceMask)

Set Groups to Ignore Mask

Declaration
public void SetGroupsToIgnoreMask(NavAvoidanceMask GroupMask)
Parameters
Type Name Description
NavAvoidanceMask GroupMask
| Improve this Doc View Source

SetHandbrakeInput(Boolean)

Set the user input for handbrake

Declaration
public void SetHandbrakeInput(bool bNewHandbrake)
Parameters
Type Name Description
System.Boolean bNewHandbrake
| Improve this Doc View Source

SetSteeringInput(Single)

Set the user input for the vehicle steering

Declaration
public void SetSteeringInput(float Steering)
Parameters
Type Name Description
System.Single Steering
| Improve this Doc View Source

SetTargetGear(Int32, Boolean)

Set the user input for gear (-1 reverse, 0 neutral, 1+ forward)

Declaration
public void SetTargetGear(int GearNum, bool bImmediate)
Parameters
Type Name Description
System.Int32 GearNum
System.Boolean bImmediate
| Improve this Doc View Source

SetThrottleInput(Single)

Set the user input for the vehicle throttle

Declaration
public void SetThrottleInput(float Throttle)
Parameters
Type Name Description
System.Single Throttle
| Improve this Doc View Source

SetUseAutoGears(Boolean)

Set the flag that will be used to select auto-gears

Declaration
public void SetUseAutoGears(bool bUseAuto)
Parameters
Type Name Description
System.Boolean bUseAuto

Operators

| Improve this Doc View Source

Implicit(IntPtr to WheeledVehicleMovementComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator WheeledVehicleMovementComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
WheeledVehicleMovementComponent