Template:Vehicle/doc: Difference between revisions

Template page
No edit summary
(Replaced content with ".")
Tag: Replaced
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{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.
 
<syntaxhighlight lang="wikitext">
{{Vehicle}}
</syntaxhighlight>
 
Optional parameters:
{{Note|'''Note''': Like other infoboxes, you don't need to put units and separators in the infobox. It will be added automatically.}}
<syntaxhighlight lang="wikitext">
{{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 -->
| name = <!-- Name override of the vehicle if different from the page name -->
| smwqueryname = <!-- SMW query override -->
| uuid = <!-- UUID of the vehicle -->
}}
</syntaxhighlight>
 
The following parameters are needed if there are no data in game or on ship matrix.
<syntaxhighlight lang="wikitext">
{{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 -->
}}
</syntaxhighlight>
 
== TemplateData ==
<templatedata>
{
"params": {
"image": {
"label": "Image",
"description": "The file name of the image of the ship/vehicle",
"example": "Defender0.jpg",
"type": "string",
"suggested": true
},
"name": {
"label": "Name",
"description": "The name of the ship/vehicle",
"example": "Defender",
"type": "string",
"required": true
},
"manufacturer": {
"label": "Manufacturer",
"description": "The manufacturer code of the manufacturer who made the ship/vehicle",
"example": "BANU",
"type": "string",
"suggested": true
},
"size": {
"label": "Size",
"description": "The size of the ship/vehicle (Vehicle/Snub/Small/Medium/Large/Capital)",
"example": "Small",
"type": "string",
"suggested": true
},
"mincrew": {
"label": "Min crew",
"description": "The minimum crew of the ship/vehicle",
"example": "1",
"type": "number",
"required": true
},
"maxcrew": {
"label": "Max crew",
"description": "The maximum crew of the ship/vehicle",
"example": "2",
"type": "number",
"required": true
},
"series": {
"label": "Ship/vehicle series",
"description": "The ship/vehicle series that this ship/vehicle belongs to",
"example": "Avenger",
"type": "string"
},
"cargocapacity": {
"label": "Cargo capacity",
"description": "The cargo capacity of the ship in SCU",
"example": "300",
"type": "number",
"suggested": true
},
"productionstate": {
"label": "Production state",
"description": "The production state of the ship/vehicle from RSI website",
"example": "In production",
"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": {
"label": "Mass",
"description": "The null cargo mass of the ship (only needed if different from in-game or ship matrix data)",
"example": "78406",
"type": "number"
},
"length": {
"label": "Length",
"description": "The length of the ship/vehicle",
"example": "33.5",
"type": "number",
"suggested": true
},
"width": {
"label": "Width",
"description": "The width of the ship/vehicle",
"example": "13.2",
"type": "number",
"suggested": true,
"aliases": [
"beam"
]
},
"height": {
"label": "Height",
"description": "The height of the ship/vehicle",
"example": "4",
"type": "number",
"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": {
"label": "Maximum speed",
"description": "The maximum speed of the ship/vehicle (only needed if different from in-game or ship matrix data)",
"example": "1200",
"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": {
"label": "Role",
"description": "The role of the ship/vehicle",
"example": "Light fighter",
"type": "string",
"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": {},
"smwqueryname": {}
},
"description": "Handles data related to vehicles.",
"paramOrder": [
"image",
"name",
"manufacturer",
"role",
"size",
"sizenum",
"mincrew",
"maxcrew",
"series",
"cargocapacity",
"productionstate",
"productionstatedesc",
"pledgeavailability",
"pledgecost",
"originalpledgecost",
"warbondcost",
"originalwarbondcost",
"length",
"width",
"height",
"combatspeed",
"maxspeed",
"mass",
"releasedate",
"retiredate",
"rsistoreurl",
"galactapediaurl",
"presentationurl1",
"brochureurl",
"trailerurl",
"qandaurl1",
"qandaurl2",
"qandaurl3",
"presentationurl2",
"presentationurl3",
"conceptdate",
"saledate",
"whitleysguideurl",
"retractedlength",
"retractedheight",
"retractedwidth",
"uuid",
"smwqueryname"
],
"format": "{{_\n| _______________________________ = _\n}}\n"
}
</templatedata>
<includeonly>
<!-- Template catergories go here -->
[[Category:Infobox templates]]
</includeonly>

Latest revision as of 23:38, 5 March 2024

.