Editing Template:Vehicle specifications/doc

{{Documentation}}
This template handles data related to vehicles and displays vehicle specifications.

On the vehicle page
*Saves template parameters as Semantic MediaWiki data
*Set category from template parameters (TBA)
*Display vehicle specifications tables and tabbers

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

== Usage ==
The template does not strictly require any parameters to be set.

<syntaxhighlight lang="wikitext">
{{Vehicle_specifications}}
</syntaxhighlight>

Suggested parameters:
{{Note|'''Note''': Like other templates, you don't need to put units and separators in the infobox; it will be added automatically. Whitespace is automatically trimmed.}}
<syntaxhighlight lang="wikitext">
{{Vehicle
<!-- General tabber -->
| manufacturer = <!-- Manufacturer of the vehicle -->
| model = <!-- Model of the vehicle -->
| trim = <!-- Trim of the vehicle -->
| model_year = <!-- Model of the vehicle -->
| vehicle_id = <!-- Vehicle ID of the vehicle (for development usage) -->
| team = <!-- Required team to use the vehicle -->
| job = <!-- Required civilian job for using the vehicle -->
| form_factor = <!-- Form factor of the vehicle -->
| type = <!-- Type of the vehicle -->
| class = <!-- Class of the vehicle -->
| price = <!-- Dealership price of the vehicle -->
| discounted_price = <!-- Discounted price of the vehicle -->
| rank = <!-- Required rank for unlocking the vehicle -->
<!-- Performance tabber -->
| top_speed = <!-- Top speed of the vehicle in MPH -->
| top_reverse_speed = <!-- Top reverse speed of the vehicle in MPH -->
| acceleration = <!-- 0 to 60 MPH acceleration time of the vehicle in seconds with two decimals -->
| deceleration = <!-- 60 to 0 MPH deceleration time of the vehicle in seconds with two decimals -->
<!-- Structure tabber -->
| transmission = <!-- The amount of gears a vehicle has -->
| fuel_capacity = <!-- The amount of fuel a vehicle can hold in gallons -->
| battery_size = <!-- The battery size of an electric vehicle in kWh-->
| drivetrain = <!-- The drivetrain of the vehicle -->
| health = <!-- The amount of health a vehicle has -->
<!-- Frame tabber -->
| seats = <!-- The amount of seats a vehicle has -->
| wheels = <!-- The amount of wheels a vehicle has -->
| inspired_by = <!-- The real-life vehicle that this vehicle has taken the most inspiration from -->
| inspired_by_url = <!-- External link to the real-life inspiration vehicle -->
}}
</syntaxhighlight>

== TemplateData ==
<templatedata>
{
	"params": {
		"manufacturer": {
			"label": "Manufacturer",
			"description": "Manufacturer of the vehicle",
			"example": "Chevlon",
			"type": "string",
			"suggested": true
		},
		"model": {
			"label": "Model",
			"description": "Model of the vehicle",
			"example": "Captain",
			"suggested": true,
			"type": "string"
		},
		"trim": {
			"label": "Trim",
			"description": "Trim of the vehicle",
			"example": "Standard",
			"type": "string",
			"suggested": true
		},
		"model_year": {
			"label": "Model year",
			"description": "Model year of the vehicle",
			"example": "1992",
			"type": "number",
			"suggested": true
		},
		"vehicle_id": {
			"label": "Vehicle ID",
			"description": "Vehicle ID of the vehicle (for development usage)",
			"example": "6",
			"type": "number",
			"suggested": true
		},
		"form_factor": {
			"label": "Form factor",
			"description": "Form factor of the vehicle",
			"example": "Standard",
			"type": "string",
			"suggestedvalues": [
				"Standard",
				"Trailer",
				"ATV"
			],
			"suggested": true
		},
		"type": {
			"label": "Type",
			"description": "Type of the vehicle",
			"type": "string",
			"suggestedvalues": [
				"Regular",
				"Prestige",
				"Electric",
				"Classic"
			],
			"suggested": true
		},
		"class": {
			"label": "Class",
			"description": "Class of the vehicle",
			"example": "Car",
			"type": "string",
			"suggestedvalues": [
				"Car",
				"Truck",
				"SUV",
				"Industrial"
			],
			"suggested": true
		},
		"price": {
			"label": "Price",
			"description": "Dealership price of the vehicle",
			"example": "0",
			"type": "number",
			"suggested": true
		},
		"discounted_price": {
			"label": "Discounted price",
			"description": "Discounted (for sale) price of the vehicle",
			"example": "0",
			"type": "number",
			"suggested": true
		},
		"rank": {
			"label": "Rank",
			"description": "Required rank number for unlocking the vehicle",
			"example": "3",
			"type": "number",
			"suggested": true
		},
		"team": {
			"label": "Team",
			"description": "Required team to use the vehicle (use Law Enforcement if the vehicle is available on both Police and Sheriff)",
			"example": "Civilian",
			"type": "string",
			"suggestedvalues": [
				"Civilian",
				"Liberty County Sheriff's Office",
				"River City Fire & Rescue",
				"River City Police Department",
				"Department of Transportation",
				"Law Enforcement"
			],
			"suggested": true
		},
		"job": {
			"label": "Job",
			"description": "Required civilian job for using the vehicle",
			"type": "string",
			"suggestedvalues": [
				"Postal Worker",
				"Hospital Worker",
				"Farmer",
				"Valley Transit Worker",
				"Fast Food Restaurant Worker",
				"Bank Worker",
				"Garbage Collector",
				"Barber Shop Worker",
				"Cafe Worker",
				"Eagle Construction Worker",
				"Rick and John's Worker",
				"Bakery Worker",
				"Movie Theatre Worker",
				"La Mesa Restaurant Worker",
				"Gas Depot Worker",
				"Gadget Shack Worker",
				"Judge",
				"News Worker",
				"Gas Station Worker"
			],
			"suggested": true
		},
		"top_speed": {
			"label": "Top speed",
			"description": "Top speed of the vehicle in MPH",
			"example": "108",
			"type": "number",
			"suggested": true
		},
		"top_reverse_speed": {
			"label": "Top reverse speed",
			"description": "Top reverse speed of the vehicle in MPH",
			"example": "24",
			"type": "number",
			"suggested": true
		},
		"acceleration": {
			"label": "Acceleration",
			"description": "0 to 60 MPH acceleration time of the vehicle in seconds with two decimals",
			"example": "5.23",
			"type": "number",
			"suggested": true
		},
		"deceleration": {
			"label": "Deceleration",
			"description": "60 to 0 MPH deceleration time of the vehicle in seconds with two decimals",
			"example": "2.63",
			"type": "number",
			"suggested": true
		},
		"transmission": {
			"label": "Transmission",
			"description": "The amount of gears a vehicle has",
			"example": "6",
			"type": "number",
			"suggested": true
		},
		"fuel_capacity": {
			"label": "Fuel capacity",
			"description": "The amount of fuel a vehicle can hold in gallons",
			"example": "24",
			"type": "number",
			"suggested": true
		},
		"battery_size": {
			"label": "Battery size",
			"description": "The battery size of an electric vehicle in kWh",
			"example": "64.5",
			"type": "number",
			"suggested": true
		},
		"drivetrain": {
			"label": "Drivetrain",
			"description": "The drivetrain of the vehicle",
			"example": "Rear",
			"type": "string",
			"suggestedvalues": [
				"Rear",
				"Front",
				"All"
			],
			"suggested": true
		},
		"health": {
			"label": "Health",
			"description": "The amount of health a vehicle has",
			"example": "150",
			"type": "number",
			"suggested": true
		},
		"seats": {
			"label": "Seats",
			"description": "The amount of seats a vehicle has",
			"example": "2",
			"type": "number",
			"suggested": true
		},
		"wheels": {
			"label": "Wheels",
			"description": "The amount of wheels a vehicle has",
			"example": "4",
			"type": "number",
			"suggested": true
		},
		"inspired_by": {
			"label": "Inspired by",
			"description": "The real-life vehicle that this vehicle has taken the most inspiration from",
			"example": "Holden WM Caprice 2006",
			"type": "string",
			"suggested": true
		},
		"inspired_by_url": {
			"label": "Inspired by URL",
			"description": "External link to the real-life inspiration vehicle",
			"example": "https://en.wikipedia.org/wiki/Holden_Caprice_(WM)",
			"type": "url",
			"suggested": true
		}
	},
	"description": "Handles data related to vehicles and displays vehicle specifications.",
	"format": "block",
	"paramOrder": [
		"manufacturer",
		"model",
		"trim",
		"model_year",
		"vehicle_id",
		"team",
		"job",
		"form_factor",
		"type",
		"class",
		"price",
		"discounted_price",
		"rank",
		"top_speed",
		"top_reverse_speed",
		"acceleration",
		"deceleration",
		"transmission",
		"fuel_capacity",
		"battery_size",
		"drivetrain",
		"health",
		"seats",
		"wheels",
		"inspired_by",
		"inspired_by_url"
	]
}
</templatedata>