Properties

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

Property

Type

Description

RotorcraftModel

get; set;

Transform

Returns the Transform for the assigned rotorcraft model.

RotorcraftRigidbody

get; set;

Rigidbody

Returns the Rigidbody assigned to the RotorcraftBehaviour.

RotorcraftSettings

get; set;

RotorcraftBehaviourSettings

Returns the RotorcraftBehaviourSettings for the rotorcraft.

Acceleration

get;

float

How fast the rotorcraft reaches the maxspeed. Range 1 - 150.

DefaultMaxSpeed

get;

float

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

MaxSpeed

get; set;

float

How fast your rotorcraft can move.

Range 5 - 750.

BreakSpeed

get;

float

How fast your rotorcraft breaks.

Range 1 - 150.

BoostSpeed

get;

float

The value to increase speed by when boosting, resulting in MaxSpeed+BoostSpeed.

Range 5 - 200.

DefaultSteering

get;

float

Returns Steering from the Vehicle settings.

Steering

get; set;

float

Controls how tight of a turning circle the rotorcraft has (higher value means a tighter turn).

Range 0 - 100.

MaxRollSpeed

get;

float

How fast the rotorcraft moves when rolling left/ right.

Range 1 - 750.

Gravity

get;

float

A multiplier used to determine how quickly the rotorcraft falls to the ground. Range 0 – 20 (higher value results in a faster fall).

ThrottleSpeed

get;

float

The speed at which the rotorcraft moves up/ down.

Range 1 - 100.

Pitch

get;

float

Rotation on the X axis, used in the forward/reverse movement.

Range 0 - 150.

Yaw

get;

float

Rotation on the Z axis, used when turning. If the rotorcraft is stationary, the yaw = 0 and no tilt occurs.

Range 0 - 150.

Roll

get;

float

Rotation on the Z axis, used when moving left/right with the roll (in a strafing movement).

Range 0 - 150.

NearGround

get; private set;

bool

Returns if the vehicle is close to the ground.

OnGround

get; private set;

bool

Returns if the vehicle is grounded.

GroundMask

get;

LayerMask

Returns the layer mask for the ground setting in this rotorcrafts settings.

EngineEnabled

get;

bool

Returns if the engine is currently running.

IsBoosting

get; private set;

bool

Returns if the rotorcraft is currently boosting.

GetVelocitySqrMagnitude

get;

float

Returns the velocity square magnitude of the vehicle as a float.

GetVelocity

get;

Vector3

Returns the velocity of the vehicle as Vecto3.

Last updated