Documentation

HoverKit Documentation

HoverKit provides a small set of components which implement all of the functionality you need to create a hovering vehicle of any kind. Each of these components is described briefly below, with links on the right-hand side to navigate to the detailed documentation for each component.

page-logo

HoverKit Components

HoverLift Component

The HoverLift Component is responsible for providing your vehicle’s hovering capabilities. It does this by performing raycasts from user-defined points on the vehicle downward to the surface on which the vehicle should float. The results of these raycasts are used to determine the forces that need to be applied to the vehicle’s Rigidbody in order to make it hover at the specified height.

It is also responsible for keeping the vehicle upright and aligned with the ground surface, and allows the developer to specify how this auto-correcting functionality is performed.

HoverMovement Component

The HoverMovement Component is responsible for providing your vehicle’s forward and lateral movement. It continuously calculates and applies the correct physics forces necessary to move the vehicle’s Rigidbody in the desired direction at the desired speed.

To move the vehicle, simply set the ForwardSpeed and/or LateralSpeed properties or call the SetSpeedNormalized function (see the API docs for more information) to indicate the speed at which you’d like the vehicle to move, and the HoverMovement Component takes care of the rest. This makes it easy to drive the vehicle from user input or even an AI script.

HoverTurning Component

The HoverTurning Component is responsible for providing your vehicle’s turning capabilities.

It does this by continually monitoring the Rigidbody’s angular velocity and calculating and applying the physics forces necessary to accurately control the turn rate or cancel unwanted angular momentum.

HoverVehicle Component

The HoverVehicle Component is responsible for managing the proper execution of the other HoverKit components (HoverLift, HoverMovement, HoverTurning), as well as providing convenient centralized access to those components via cached public properties.

It is also responsible for keeping the vehicle upright and aligned with the ground surface, and allows the developer to specify how this auto-correcting functionality is performed.

QuickStart Guide

We’ve created a brief Quick Start page to guide you through the process of creating your first hovering vehicle. It shows you the fastest and easiest way to get started, and provides an introduction to the HoverKit components that are available.

Check out the guide, and come back here when you’re ready for more detailed information on how to configure your vehicles to get exactly the behavior you want.

HoverKit API Documentation

For developers who wish to go beyond the built-in components and code against the HoverKit API directly, we’ve published the source code documentation online (generated by Doxygen).