Latest revision as of 08:46, 29 May 2024

JavaScript

Creates a vehicle in given position.

JavaScript Syntax

Syntax

mp.vehicles.new(model, position,
{
    heading: heading,
    numberPlate: numberPlate,
    alpha: alpha,
    color: color,
    locked: locked,
    engine: engine,
    dimension: dimension
});

Parameters

Note: Question marked parameters are optional.

model: Hash (use mp.joaat) or String
position: Vector3
heading?: Number [-180:180]
numberPlate?: String
alpha?: Number
color?: [[Number, Number, Number], [Number, Number, Number]]
locked?: Boolean
engine?: Boolean
dimension?: Number

Examples

An example of creating a red Turismo with the license plate ADMIN

Client-Side

mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326), 
    {
        numberPlate: "ADMIN",
        color: [[255, 0, 0],[255,0,0]]
    });

Same example but creating a blue Turismo and using it server-side

Server-Side

mp.vehicles.new(mp.joaat("turismor"), new mp.Vector3(-441.88, 1156.86, 326),
    {
        numberPlate: "ADMIN",
        color: [[0, 255, 0],[0, 255, 0]]
    });

@@ Line 1: / Line 1: @@
-This function creates the vehicle.
+{{sharedFunctionJS}}
+Creates a vehicle in given position.
+{{JSContainer|
 == Syntax ==
-<syntaxhighlight lang="javascript">
+<pre>
-let vehicle = mp.vehicles.new(Number modelHash, Vector3 position)
+mp.vehicles.new(model, position,
-</syntaxhighlight>
+{
+    heading: heading,
+    numberPlate: numberPlate,
+    alpha: alpha,
+    color: color,
+    locked: locked,
+    engine: engine,
+    dimension: dimension
+});
+</pre>
-== Example ==
+== Parameters ==
-This example creates the vehicle from name.
+Note: Question marked parameters are optional.
-<syntaxhighlight lang="javascript">
+*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
-mp.events.add('playerCommand', (player, cmd) => {
+*'''position''': {{RageType|[[Vector3::Vector3|Vector3]]}}
-	let arr = cmd.split(' ');
+*'''heading?''': {{RageType|Number}} [-180:180]
-	if (arr[0] == 'veh') {
+*'''numberPlate?''': {{RageType|String}}
-		if (!arr[1]) {
+*'''alpha?''': {{RageType|Number}}
-			return player.outputChatBox('Use syntax: /veh [vehicle_name]');
+*'''color?''': {{RageType|[[Number, Number, Number], [Number, Number, Number]]}}
-		} else {
+*'''locked?''': {{RageType|Boolean}}
-			let pos = player.position;
+*'''engine?''': {{RageType|Boolean}}
-			pos.x += 3;
+*'''dimension?''': {{RageType|Number}}
-			mp.vehicles.new(mp.joaat(arr[1]), pos);
-		}
+== Examples ==
-	}
-});
+An example of creating a red Turismo with the license plate ADMIN
-</syntaxhighlight>
+{{ClientsideCode|
+<pre>
+mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326),
+    {
+        numberPlate: "ADMIN",
+        color: [[255, 0, 0],[255,0,0]]
+    });
+</pre>
+}}
+Same example but creating a blue Turismo and using it server-side
+{{ServersideCode|
+<pre>
+mp.vehicles.new(mp.joaat("turismor"), new mp.Vector3(-441.88, 1156.86, 326),
+    {
+        numberPlate: "ADMIN",
+        color: [[0, 255, 0],[0, 255, 0]]
+    });
+</pre>
+}}
+}}
+==See also==
+'''Client Side'''
+{{Vehicle_definition_c}}
+[[Category:Vehicle API]]
+[[Category:Clientside API]]
+[[Category:Client-side Function]]
+[[Category:Shared Function]]
+'''Server Side'''
+*Functions
+{{Vehicle_functions}}
+{{Entity_functions}}
+*Properties
+{{Vehicle_properties}}
+{{Entity_properties}}