Template:Vehicle/doc

From IxWiki
Revision as of 20:04, 15 May 2024 by sc>Alistair3149
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This template handles data related to vehicles.

On the vehicle page

  • Saves template parameters and API data as SMW data
  • Set category from SMW data
  • Set short description from SMW data
  • Display infobox from SMW data

On other pages, it can be used to display the infobox of other vehicles.

Usage

The template should fill in data automatically from API even if there are no template parameters.

{{Vehicle}}

Optional parameters:

Note: Like other infoboxes, you don't need to put units and separators in the infobox. It will be added automatically.
{{Vehicle
| uuid = <!-- UUID of the vehicle -->
| image = <!-- Image name on wiki -->
| manufacturer = <!-- Manufacturer code -->
| productionstate = <!-- In Concept/In Production/Flight Ready -->
| productionstatedesc = <!-- [[Star Citizen Alpha X.X.X|Alpha X.X.X]] -->
| mincrew = <!-- Minimum crew of the vehicle -->
| maxcrew = <!-- Maximum crew of the vehicle -->
| pledgecost = <!-- Current pledge store price -->
| originalpledgecost = <!-- Initial pledge store price -->
| warbondcost = <!-- Current warbond pledge store price -->
| originalwarbondcost = <!-- Initial warbond pledge store price -->
| pledgeavailability = <!-- Always available/Time-limited sales/Quantity-limited sales/Promotion-only -->
| length = <!-- Length of the vehicle -->
| retractedlength = <!-- Length of the vehicle in retracted state -->
| height = <!-- Height of the vehicle -->
| retractedheight = <!-- Height of the vehicle in retracted state -->
| width = <!-- Width of the vehicle -->
| retractedwidth = <!-- Width of the vehicle in retracted state -->
| releasedate = <!-- Lore release date of the vehicle -->
| retiredate = <!-- Lore retirement date of the vehicle -->
| developedfrom = <!-- Wikilink of the predecessor of the vehicle -->
| developedinto = <!-- Wikilink of the successor of the vehicle -->
| conceptdate = <!-- Date when the vehicle was first announced -->
| rsistoreurl = <!-- URL of pledge store page -->
| brochureurl = <!-- URL of vehicle brochure page -->
| trailerurl = <!-- URL of trailer page on YouTube -->
| presentationurl1 = <!-- URL of the comm-link presentation page -->
| qandaurl1 = <!-- URL of Q&A page -->
| galactapediaurl = <!-- URL of Galactapedia page -->
| whitleysguideurl = <!-- URL of Whitley's Guide page -->
| name = <!-- Name override of the vehicle if different from the page name -->
| smwqueryname = <!-- SMW query override -->
| queryimage = <!-- Image override for other templates such as vehicle variants -->
}}

The following parameters are needed if there are no data in game or on ship matrix.

{{Vehicle
| name = <!-- Vehicle name -->
| size = <!-- Size of the vehicle (e.g. vehicle/small/medium/large/capital) -->
| role = <!-- Role in game description or RSI website -->
| cargocapacity = <!-- Cargo capacity in SCU -->
}}

TemplateData

Handles data related to vehicles.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Imageimage

The file name of the image of the ship/vehicle

Example
Defender0.jpg
Stringsuggested
Namename

The name of the ship/vehicle

Example
Defender
Stringrequired
Manufacturermanufacturer

The manufacturer code of the manufacturer who made the ship/vehicle

Example
BANU
Stringsuggested
Rolerole

The role of the ship/vehicle

Example
Light fighter
Stringsuggested
Sizesize

The size of the ship/vehicle (Vehicle/Snub/Small/Medium/Large/Capital)

Example
Small
Stringsuggested
Numeric sizesizenum

Numeric size of the vehicle

Example
2
Numbersuggested
Min crewmincrew

The minimum crew of the ship/vehicle

Example
1
Numberrequired
Max crewmaxcrew

The maximum crew of the ship/vehicle

Example
2
Numberrequired
Ship/vehicle seriesseries

The ship/vehicle series that this ship/vehicle belongs to

Example
Avenger
Stringoptional
Cargo capacitycargocapacity

The cargo capacity of the ship in SCU

Example
300
Numbersuggested
Production stateproductionstate

The production state of the ship/vehicle from RSI website

Example
In production
Stringoptional
Production state descriptionproductionstatedesc

Additional description that will explain the production state

Example
Active for [[Star Citizen Alpha 3.7.0|Alpha 3.7]]
Stringoptional
Pledge avaliabilitypledgeavailability

The pledge availability of the ship/vehicle

Example
Time-limited sales
Stringoptional
Pledge costpledgecost

The pledge cost in USD of the ship/vehicle on RSI website

Example
185
Numberoptional
Original pledge costoriginalpledgecost

The original pledge cost in USD of the vehicle when it first announced

Example
90
Numberoptional
Warbond costwarbondcost

The warbond cost in USD of the ship/vehicle on RSI website

Numberoptional
Original Warbond costoriginalwarbondcost

The original pledge cost in USD of the vehicle when it first announced

Numberoptional
Lengthlength

The length of the ship/vehicle

Example
33.5
Numbersuggested
Widthwidth beam

The width of the ship/vehicle

Example
13.2
Numbersuggested
Heightheight

The height of the ship/vehicle

Example
4
Numbersuggested
Combat speedcombatspeed

The combat speed of the ship/vehicle, where the default speed limiter is (only needed if different from in-game or ship matrix data)

Example
200
Numberoptional
Maximum speedmaxspeed

The maximum speed of the ship/vehicle (only needed if different from in-game or ship matrix data)

Example
1200
Numberoptional
Massmass

The null cargo mass of the ship (only needed if different from in-game or ship matrix data)

Example
78406
Numberoptional
Introductionreleasedate

First release date of the vehicle in lore

Example
2772
Dateoptional
Retiredretiredate

Retirement date of the vehicle in lore

Example
2912
Dateoptional
RSI store URLrsistoreurl

The URL of the ship/vehicle on RSI store (note that it is not the package page)

Example
https://robertsspaceindustries.com/pledge/ships/defender/Defender
URLsuggested
Galactapedia URLgalactapediaurl

The URL of the ship/vehicle on Galactapedia

Example
https://robertsspaceindustries.com/galactapedia/article/V3qgm9vdxm-defender
URLoptional
Presentation URLpresentationurl1 presentationurl

The URL of the presentation page in Comm-Link

Example
https://robertsspaceindustries.com/comm-link/transmission/15862-Banu-Defender
Auto value
URLsuggested
Brochure URLbrochureurl

The URL of the vehicle brochure

Example
https://robertsspaceindustries.com/media/q47zalzz81ml4r/source/Banu-Defender.pdf
URLoptional
Trailer URLtrailerurl

The URL of the vehicle trailer

Example
https://www.youtube.com/watch?v=O6hXjxQ0_lk
URLoptional
Q&A URL 1qandaurl1

The URL of the Q&A

Example
https://robertsspaceindustries.com/comm-link/engineering/16872-Q-A-Aopoa-Santoky-i
URLoptional
Q&A URL 2qandaurl2

The URL of the Q&A

Example
https://robertsspaceindustries.com/comm-link/engineering/16872-Q-A-Aopoa-Santoky-i
URLoptional
Q&A URL 3qandaurl3

The URL of the Q&A

Example
https://robertsspaceindustries.com/comm-link/engineering/16872-Q-A-Aopoa-Santoky-i
URLoptional
Presentation URL 2presentationurl2

The URL of the presentation page in Comm-Link

URLoptional
Presentation URL 3presentationurl3

The URL of the presentation page in Comm-Link

URLoptional
Announced dateconceptdate

Date when the vehicle was first announced

Example
2021-11-12
Dateoptional
Whitley's Guide URLwhitleysguideurl

The URL of the Whitley's Guide page in Comm-Link

Example
https://robertsspaceindustries.com/comm-link/spectrum-dispatch/19081-Whitleys-Guide-Terrapin
URLsuggested
Retracted lengthretractedlength

Length of the vehicle in retracted state

Numberoptional
Retracted heightretractedheight

Height of the vehicle in retracted state

Numberoptional
Retracted widthretractedwidth

Width of the vehicle in retracted state

Numberoptional
UUIDuuid

UUID of the Vehicle/Ship

Example
97648869-5fa5-42da-b804-4d9314289539
Stringsuggested
SMW query namesmwqueryname

The page name to load data from

Page nameoptional
Query imagequeryimage

The file name of the alternative image of the ship/vehicle used by other templates

Example
Defender.jpg
Fileoptional