Template:Vehicle/doc: Difference between revisions

Template page
No edit summary
No edit summary
Line 97: Line 97:
"cargocapacity": {
"cargocapacity": {
"label": "Cargo capacity",
"label": "Cargo capacity",
"description": "The cargo capacity of the ship in SCU",
"description": "The cargo capacity of the ship in L (Liters)",
"example": "300",
"example": "125",
"type": "number",
"type": "number",
"suggested": true
"suggested": true
Line 104: Line 104:
"productionstate": {
"productionstate": {
"label": "Production state",
"label": "Production state",
"description": "The production state of the ship/vehicle from RSI website",
"description": "The production state of the ship/vehicle",
"example": "In production",
"example": "In Production/Retired",
"type": "string"
"type": "string"
},
"productionstatedesc": {
"label": "Production state description",
"description": "Additional description that will explain the production state",
"example": "Active for [[Star Citizen Alpha 3.7.0|Alpha 3.7]]",
"type": "string"
},
"pledgeavailability": {
"label": "Pledge avaliability",
"description": "The pledge availability of the ship/vehicle ",
"example": "Time-limited sales",
"type": "string"
},
"pledgecost": {
"label": "Pledge cost",
"description": "The pledge cost in USD of the ship/vehicle on RSI website",
"example": "185",
"type": "number"
},
},
"mass": {
"mass": {
"label": "Mass",
"label": "Mass",
"description": "The null cargo mass of the ship (only needed if different from in-game or ship matrix data)",
"description": "The raw mass of the ship in kg (kilograms) or t (metric tons)",
"example": "78406",
"example": "700",
"type": "number"
"type": "number"
},
},
"length": {
"length": {
"label": "Length",
"label": "Length",
"description": "The length of the ship/vehicle",
"description": "The length of the ship/vehicle in meters",
"example": "33.5",
"example": "33.5",
"type": "number",
"type": "number",
Line 141: Line 123:
"width": {
"width": {
"label": "Width",
"label": "Width",
"description": "The width of the ship/vehicle",
"description": "The width of the ship/vehicle in meters",
"example": "13.2",
"example": "13.2",
"type": "number",
"type": "number",
Line 151: Line 133:
"height": {
"height": {
"label": "Height",
"label": "Height",
"description": "The height of the ship/vehicle",
"description": "The height of the ship/vehicle in meters",
"example": "4",
"example": "4",
"type": "number",
"type": "number",
"suggested": true
"suggested": true
},
"combatspeed": {
"label": "Combat speed",
"description": "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",
"type": "number"
},
},
"maxspeed": {
"maxspeed": {
"label": "Maximum speed",
"label": "Maximum speed",
"description": "The maximum speed of the ship/vehicle (only needed if different from in-game or ship matrix data)",
"description": "The maximum speed of the ship/vehicle in m/s (meters/second)",
"example": "1200",
"example": "170",
"type": "number"
"type": "number"
},
"rsistoreurl": {
"label": "RSI store URL",
"description": "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",
"type": "url",
"suggested": true
},
"galactapediaurl": {
"label": "Galactapedia URL",
"description": "The URL of the ship/vehicle on Galactapedia",
"example": "https://robertsspaceindustries.com/galactapedia/article/V3qgm9vdxm-defender",
"type": "url"
},
"releasedate": {
"label": "Introduction",
"description": "First release date of the vehicle in lore",
"example": "2772",
"type": "date"
},
"retiredate": {
"label": "Retired",
"description": "Retirement date of the vehicle in lore",
"example": "2912",
"type": "date"
},
"originalpledgecost": {
"label": "Original pledge cost",
"description": "The original pledge cost in USD of the vehicle when it first announced",
"example": "90",
"type": "number"
},
"brochureurl": {
"label": "Brochure URL",
"description": "The URL of the vehicle brochure",
"example": "https://robertsspaceindustries.com/media/q47zalzz81ml4r/source/Banu-Defender.pdf",
"type": "url"
},
"trailerurl": {
"label": "Trailer URL",
"description": "The URL of the vehicle trailer",
"example": "https://www.youtube.com/watch?v=O6hXjxQ0_lk",
"type": "url"
},
},
"role": {
"role": {
"label": "Role",
"label": "Role",
"description": "The role of the ship/vehicle",
"description": "The role of the ship/vehicle",
"example": "Light fighter",
"example": "Prospector",
"type": "string",
"type": "string",
"suggested": true
"suggested": true
},
"warbondcost": {
"label": "Warbond cost",
"description": "The warbond cost in USD of the ship/vehicle on RSI website",
"type": "number"
},
"originalwarbondcost": {
"label": "Original Warbond cost",
"description": "The original pledge cost in USD of the vehicle when it first announced",
"type": "number"
},
"qandaurl1": {
"label": "Q&A URL 1",
"description": "The URL of the Q&A",
"example": "https://robertsspaceindustries.com/comm-link/engineering/16872-Q-A-Aopoa-Santoky-i",
"type": "url"
},
"qandaurl2": {
"label": "Q&A URL 2",
"description": "The URL of the Q&A",
"example": "https://robertsspaceindustries.com/comm-link/engineering/16872-Q-A-Aopoa-Santoky-i",
"type": "url"
},
"qandaurl3": {
"label": "Q&A URL 3",
"description": "The URL of the Q&A",
"example": "https://robertsspaceindustries.com/comm-link/engineering/16872-Q-A-Aopoa-Santoky-i",
"type": "url"
},
"presentationurl1": {
"aliases": [
"presentationurl"
],
"label": "Presentation URL",
"description": "The URL of the presentation page in Comm-Link",
"example": "https://robertsspaceindustries.com/comm-link/transmission/15862-Banu-Defender",
"type": "url",
"autovalue": "",
"suggested": true
},
"presentationurl2": {
"label": "Presentation URL 2",
"description": "The URL of the presentation page in Comm-Link",
"type": "url"
},
"presentationurl3": {
"label": "Presentation URL 3",
"description": "The URL of the presentation page in Comm-Link",
"type": "url"
},
"conceptdate": {
"label": "Announced date",
"description": "Date when the vehicle was first announced",
"example": "2021-11-12",
"type": "date"
},
"saledate": {
"label": "Concept sale date",
"description": "Date when the vehicle was first sold",
"example": "2021-06-05",
"type": "date"
},
"sizenum": {
"label": "Numeric size",
"description": "Numeric size of the vehicle",
"example": "2",
"type": "number",
"suggested": true
},
"whitleysguideurl": {
"label": "Whitley's Guide URL",
"description": "The URL of the Whitley's Guide page in Comm-Link",
"example": "https://robertsspaceindustries.com/comm-link/spectrum-dispatch/19081-Whitleys-Guide-Terrapin",
"type": "url",
"suggested": true
},
"retractedlength": {
"label": "Retracted length",
"description": "Length of the vehicle in retracted state",
"type": "number"
},
"retractedheight": {
"label": "Retracted height",
"description": "Height of the vehicle in retracted state",
"type": "number"
},
"retractedwidth": {
"label": "Retracted width",
"description": "Width of the vehicle in retracted state",
"type": "number"
},
},
"uuid": {},
"uuid": {},
Line 318: Line 161:
"role",
"role",
"size",
"size",
"sizenum",
"mincrew",
"mincrew",
"maxcrew",
"maxcrew",
Line 324: Line 166:
"cargocapacity",
"cargocapacity",
"productionstate",
"productionstate",
"productionstatedesc",
"pledgeavailability",
"pledgecost",
"originalpledgecost",
"warbondcost",
"originalwarbondcost",
"length",
"length",
"width",
"width",
"height",
"height",
"combatspeed",
"maxspeed",
"maxspeed",
"mass",
"mass",
"releasedate",
"retiredate",
"rsistoreurl",
"galactapediaurl",
"presentationurl1",
"brochureurl",
"trailerurl",
"qandaurl1",
"qandaurl2",
"qandaurl3",
"presentationurl2",
"presentationurl3",
"conceptdate",
"saledate",
"whitleysguideurl",
"retractedlength",
"retractedheight",
"retractedwidth",
"uuid",
"uuid",
"smwqueryname"
"smwqueryname"

Revision as of 06:42, 5 March 2024

Template:Documentation 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: Template:Note

{{Vehicle
| image = <!-- Image name on wiki -->
| manufacturer = <!-- Manufacturer name -->
| productionstate = <!-- In Production/Retired -->
| mincrew = <!-- Minimum crew of the vehicle -->
| maxcrew = <!-- Maximum crew of the vehicle -->
| length = <!-- Length of the vehicle -->
| height = <!-- Height of the vehicle -->
| width = <!-- Width of the vehicle -->
| name = <!-- Name override of the vehicle if different from the page name -->
}}

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. small grid/large grid) -->
| role = <!-- Role of the ship -->
| cargocapacity = <!-- Cargo capacity in L -->
}}

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
Graculus.jpg
Stringsuggested
Namename

The name of the ship/vehicle

Example
Graculus
Stringrequired
Manufacturermanufacturer

The manufacturer who made the ship/vehicle

Example
Enax Industries
Stringsuggested
Rolerole

The role of the ship/vehicle

Example
Prospector
Stringsuggested
Sizesize

The size of the ship/vehicle (Small grid/Large grid)

Example
Small
Stringsuggested
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
Apis
Stringoptional
Cargo capacitycargocapacity

The cargo capacity of the ship in L (Liters)

Example
125
Numbersuggested
Production stateproductionstate

The production state of the ship/vehicle

Example
In Production/Retired
Stringoptional
Lengthlength

The length of the ship/vehicle in meters

Example
33.5
Numbersuggested
Widthwidth beam

The width of the ship/vehicle in meters

Example
13.2
Numbersuggested
Heightheight

The height of the ship/vehicle in meters

Example
4
Numbersuggested
Maximum speedmaxspeed

The maximum speed of the ship/vehicle in m/s (meters/second)

Example
170
Numberoptional
Massmass

The raw mass of the ship in kg (kilograms) or t (metric tons)

Example
700
Numberoptional
uuiduuid

no description

Unknownoptional
smwquerynamesmwqueryname

no description

Unknownoptional