Database /
Vehicles
Introduction
Vehicles are actors that can be boarded and ridden.
Properties
System
Name | Explanation | Type |
---|---|---|
Name | The name of the vehicle. | String |
Appearance
Name | Explanation | Type |
---|---|---|
Sprite / Model | The sprite or model of the vehicle on maps. | Sprite or Model |
Idle Sprite / Model | The sprite or model of the vehicle when not being ridden. | Sprite or Model |
Physics
Name | Explanation | Type |
---|---|---|
Collider | The settings for the dimensions of the character collider. Values are measured in tiles. | Collider? |
Ignore Entity Collision | Whether or not to ignore collision between other entities. | Toggle |
Ignores Gravity | Whether or not the vehicle ignores the effects of gravity. | Toggle |
Ignores Obstacles | Whether or not the vehicle ignores terrain obstacles. | Toggle |
Is Clipping | Whether or not the vehicle operates independently of physics. | Toggle |
Is Pushable | Whether or not the vehicle can be pushed. | Toggle |
Prevent Collision | Whether or not the vehicle tries to avoid occupying the same tile as another entity. | Toggle |
Prevent Falling | Whether or not the vehicle tries to avoid falling. | Toggle |
Register Ignored Collisions | Whether or not to register collisions even when ignored. | Toggle |
Speed | The speed multiplier of the vehicle. | Number |
Map Configuration
Name | Explanation | Type |
---|---|---|
Enter Interaction | The interaction to trigger entering the vehicle. | Interaction? |
Exit Interaction | The interaction to trigger exiting the vehicle. | Interaction? |
Entering Script | The script that is executed before entry. | Script |
Exiting Script | The script that is executed before exit. | Script |
Entered Script | The script that is executed after entry. | Script |
Exited Script | The script that is executed after exit. | Script |
Encounter Factor | The factor applied to encounter steps. | Number |
Use Caterpillar System | Whether or not the vehicle is setup for each character in the party. | Toggle |
Is Character Visible | Whether or not the character is visible on the vehicle. | Toggle |
Character Riding Animation | The animation to apply to the character when riding the vehicle. | Character Animations |
Audio
Name | Explanation | Type |
---|---|---|
Use Custom Music | Whether or not to use custom music while riding the vehicle. | Toggle |
Custom Music | The custom music while riding the vehicle. | Music |
Tile Tags
Tile tags allow for a vehicle to be restricted or have the additional capacity to pass different Tile Tags.
Restrict To will restrict the vehicle to running only on the tile tags selected.
Can Pass will allow for the vehicle to pass the tile tags included, in addition to anything else that is normally passable.
Scripting
The scripting for vehicles allows for flexible control over how vehicles work in your game. The workflow for each is as follows:
When the interaction is met for entering:
- Entering Script
- Characters are removed from the map and placed inside or on vehicles
- Entered Script
When the interaction is met for exiting:
- Exiting Script (the entire operation is cancelled if Cancel Vehicle Exit is called in this script)
- Characters are removed from the vehicle and placed on the map
- Exited Script