Wheeled Vehicle

Parent

Vehicle

The base class for all vehicles that used wheels for movement.

Properties

burnRatio : Float

The amount of fuel this vehicle burns.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Burn Ratio

hasFuel : Bool

True if the vehicle has currently fuel to drive.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Has Fuel

isAutopilotEnabled : Bool

True if the vehicle is currently auto piloting.

Details
Flags RuntimeSync

Display Name

Is Autopilot Enabled

speed : Float

The current forward speed of this vehicle.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Speed

Functions

getCurrentTarget () → index : Int

Returns the index of the target that the vehicle tries to move to right now.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Current Target
Return Values
Name Type Description

Index index

Int

The index of the current target.

getFuelInv () → inventory : Trace<Inventory>

Returns the inventory that contains the fuel of the vehicle.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Fuel Inventory
Return Values
Name Type Description

Inventory inventory

Trace<Inventory>

The fuel inventory of the vehicle.

getStorageInv () → inventory : Trace<Inventory>

Returns the inventory that contains the storage of the vehicle.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Storage Inventory
Return Values
Name Type Description

Inventory inventory

Trace<Inventory>

The storage inventory of the vehicle.

getTargetList () → targetList : Trace<TargetList>

Returns the list of targets/path waypoints.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Target List
Return Values
Name Type Description

Target List targetList

Trace<TargetList>

The list of targets/path-waypoints.

isValidFuel (item : Class<ItemType>) → isValid : Bool

Allows to check if the given item type is a valid fuel for this vehicle.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Is Valid Fuel
Parameters
Name Type Description

Item item

Class<ItemType>

The item type you want to check.
Return Values
Name Type Description

Is Valid isValid

Bool

True if the given item type is a valid fuel for this vehicle.

setCurrentTarget (index : Int)

Sets the target with the given index as the target this vehicle tries to move to right now.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Set Current Target
Parameters
Name Type Description

Index index

Int

The index of the target this vehicle should move to now.