Properties

The main class in Arcade Vehicle Controller is VehicleBehaviour.cs, which must be attached to any vehicle for it to move.

Property

Type

Description

Acceleration

float

How fast your vehicle speeds up, Range value 1 – 12 (higher value means faster).

Set via the vehicle settings.

MaxSpeed

float

How fast your vehicle can move, Range value 1 – 100 (high value means faster).

Set via the vehicle settings.

BreakSpeed

float

How fast your vehicle brakes, Range value 1 – 15 (higher value means faster).

Set via the vehicle settings.

BoostSpeed

float

How fast your vehicle moves when boosting, Range value 5 – 200.

Set via the vehicle settings.

MaxSpeedToStartReverse

float

The speed your vehicle will be travelling when it stops braking and reverses instead, Range 1 – 500 (higher value means sooner).

Set via the vehicle settings.

Steering

float

Controls how tight of a turning circle your vehicle has, Range 20 – 160 (higher value means tighter cornering).

Set via the vehicle settings.

Gravity

float

A multiplier used to determine how quickly the vehicle falls to the ground, Range 0 – 20 (higher value means heavier vehicle).

Set via the vehicle settings.

Drift

float

Determines how slidey the vehicle is when turning, Range 0 – 1 (1 means very slidey).

Set via the vehicle settings.

VehicleBodyTilt

float

Sets how much the vehicle tilts when turning, Range 0 – 3 (higher value gives a bigger tilt)

Set via the vehicle settings.

ForwardTilt

float

Sets the multiplier for how much vehicle tilts when accelerating/ reversing, Range 1 – 10 (higher value means smaller tilt).

Set via the vehicle settings.

TurnInAir

bool

Allow the vehicle to turn in the air.

Set via the vehicle settings.

TwoWheelTilt

bool

Gives the vehicle an extra tilt when turning, this is for vehicles with 2 wheels.

Set via the vehicle settings.

NearGround

bool

Returns if the vehicle is close to the ground.

OnGround

bool

Returns if the vehicle is grounded.

GroundMask

LayerMask

Returns the layers that the vehicle can move on.

DefaultMaxSpeed

float

Returns the MaxSpeed from the Vehicle settings, allowing you to manipulate the MaxSpeed and return to the default value.

DefaultSteering

float

Returns Steering from the Vehicle settings.

IsBoosting

bool

Returns if the vehicle is currently boosting

(Added in v1.11.0)

GetVehicleVelocitySqrMagnitude

float

Returns the velocity square magnitude of the vehicle as a float, used to work out when to emit smoke.

GetVehicleVelocity

Vector3

Returns the velocity of the vehicle as Vecto3, used to work out when to emit smoke.

VehicleWheelCount

enum Vehicletype

Changes how many wheels the vehicle has.

4 wheels.

2 wheels.

No wheels.

VehicleModel

Transform

Parent transform of the vehicle model.

PhysicsSphere

Transform

Transform for the GameObject named ‘SphereRigidBody’.

VehicleBody

Transform

Transform for the ‘body’ GameObject, used for tilting.

FrontLeftWheel

Transform

Transform for the main wheel. This is used as the front left of a vehicle with 4 wheels, and the front of a 2 wheeled vehicle.

FrontRightWheel

Transform

Transform for the secondary wheel. This is used as the front right of a vehicle with 4 wheels, and the rear of a 2 wheeled vehicle.

BackLeftWheel

Transform

Back wheel.

BackRightWheel

Transform

Back wheel.

VehicleSettings

VehicleSettings

Link to the vehicle settings ScriptableObject the vehicle is using for the data.

Last updated