Module:Vehicles/data/doc

From Dune: Awakening Community Wiki
Jump to navigation Jump to search

This is the documentation page for Module:Vehicles/data

Module:Vehicles/data

Dataset of vehicles.

Schema

The dataset is a two-level table, first keyed by vehicle type, and then keyed by slugified vehicle name, derived via common.slugify() from Module:Common.

For translation-compatibility, display strings are stored exclusively in MessageBundle:Vehicles.

First key

Vehicle type (slugified). Valid types:

  • ground
  • aerial
  • special

Second key

Vehicle name, derived by slugifying the vehicle's English name. Examples:

  • sandbike
  • assault-ornithopter

Record fields

Each vehicle record is a table with the following fields:

category
string
Slugified official in-game vehicle classification indicating its size and role. Must correspond to a category-<CATEGORY_SLUG> key in MessageBundle:Vehicles.
Examples:
one-man-groundcar
four-man-groundcar
light-ornithopter
medium-ornithopter
minimum_tier
string
The lowest progression tier at which the vehicle schematics are unlocked.
Examples:
Copper
Steel
Duraluminum
crew_capacity
string
The number of seats available in the vehicle. If this value can vary due to installed modules, display it as a range (e.g. 3-4).
Examples:
1
3-4