# 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                                                                                                                                    |
| ------------------------------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>RotorcraftModel</p><p>get; set;</p>     | Transform                   | Returns the Transform for the assigned rotorcraft model.                                                                                       |
| <p>RotorcraftRigidbody</p><p>get; set;</p> | Rigidbody                   | Returns the Rigidbody assigned to the RotorcraftBehaviour.                                                                                     |
| <p>RotorcraftSettings</p><p>get; set;</p>  | RotorcraftBehaviourSettings | Returns the RotorcraftBehaviourSettings for the rotorcraft.                                                                                    |
| <p>Acceleration</p><p>get;</p>             | float                       | <p>How fast the rotorcraft reaches the maxspeed. <br>Range 1 - 150.</p>                                                                        |
| <p>DefaultMaxSpeed</p><p>get;</p>          | float                       | Returns the MaxSpeed from the Vehicle settings, allowing you to manipulate the MaxSpeed and return to the default value.                       |
| <p>MaxSpeed</p><p>get; set;</p>            | float                       | <p>How fast your rotorcraft can move.</p><p>Range 5 - 750.</p>                                                                                 |
| <p>BreakSpeed</p><p>get;</p>               | float                       | <p>How fast your rotorcraft breaks.</p><p>Range 1 - 150.</p>                                                                                   |
| <p>BoostSpeed</p><p>get;</p>               | float                       | <p>The value to increase speed by when boosting, resulting in MaxSpeed+BoostSpeed.</p><p>Range 5 - 200.</p>                                    |
| <p>DefaultSteering</p><p>get;</p>          | float                       | Returns Steering from the Vehicle settings.                                                                                                    |
| <p>Steering</p><p>get; set;</p>            | float                       | <p>Controls how tight of a turning circle the rotorcraft has (higher value means a tighter turn).</p><p>Range 0 - 100.</p>                     |
| <p>MaxRollSpeed</p><p>get;</p>             | float                       | <p>How fast the rotorcraft moves when rolling left/ right.</p><p>Range 1 - 750.</p>                                                            |
| <p>Gravity</p><p>get;</p>                  | float                       | <p>A multiplier used to determine how quickly the rotorcraft falls to the ground.<br>Range 0 – 20 (higher value results in a faster fall).</p> |
| <p>ThrottleSpeed</p><p>get;</p>            | float                       | <p>The speed at which the rotorcraft moves up/ down.</p><p>Range 1 - 100.</p>                                                                  |
| <p>Pitch</p><p>get;</p>                    | float                       | <p>Rotation on the X axis, used in the forward/reverse movement.</p><p>Range 0 - 150.</p>                                                      |
| <p>Yaw</p><p>get;</p>                      | float                       | <p>Rotation on the Z axis, used when turning. If the rotorcraft is stationary, the yaw = 0 and no tilt occurs.</p><p>Range 0 - 150.</p>        |
| <p>Roll</p><p>get;</p>                     | float                       | <p>Rotation on the Z axis, used when moving left/right with the roll (in a strafing movement).</p><p>Range 0 - 150.</p>                        |
| <p>NearGround</p><p>get; private set;</p>  | bool                        | Returns if the vehicle is close to the ground.                                                                                                 |
| <p>OnGround</p><p>get; private set;</p>    | bool                        | Returns if the vehicle is grounded.                                                                                                            |
| <p>GroundMask</p><p>get;</p>               | LayerMask                   | Returns the layer mask for the ground setting in this rotorcrafts settings.                                                                    |
| <p>EngineEnabled</p><p>get;</p>            | bool                        | Returns if the engine is currently running.                                                                                                    |
| <p>IsBoosting</p><p>get; private set;</p>  | bool                        | Returns if the rotorcraft is currently boosting.                                                                                               |
| <p>GetVelocitySqrMagnitude</p><p>get;</p>  | float                       | Returns the velocity square magnitude of the vehicle as a float.                                                                               |
| <p>GetVelocity</p><p>get;</p>              | Vector3                     | Returns the velocity of the vehicle as Vecto3.                                                                                                 |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://arcdocs.enigma23.co.uk/script-properties/properties.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.