Vehicle::Vehicle: Difference between revisions

From RAGE Multiplayer Wiki
(numberPlate is bugged)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{sharedFunctionJS}}
{{sharedFunctionJS}}
Creates a vehicle in given position.


Creates a vehicle.<br>
{{JSContainer|
'''Notes:''' <br>
- Colors don't always work as expected if you use them inside the function. Also number plate won't work properly. Better set those after vehicle is created. <br>
- Heading means Z Rotation.<br>
- in 0.3.7 numberPlate property is bugged, so set the numberPlate after vehicle creation with vehicle.numberPlate = 'plate';
== Syntax ==
== Syntax ==
<pre>
<pre>
mp.vehicles.new(model, position,
mp.vehicles.new(model, position,
Line 21: Line 17:
</pre>
</pre>


=== Parameters ===
== Parameters ==
Note: Question marked parameters are optional.
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''position''': {{RageType|[[Vector3::Vector3|Vector3]]}}
*'''position''': {{RageType|[[Vector3::Vector3|Vector3]]}}
*'''heading''': {{RageType|Number}} [-180:180]
*'''heading?''': {{RageType|Number}} [-180:180]
*'''numberPlate''': {{RageType|String}}
*'''numberPlate?''': {{RageType|String}}
*'''alpha''': {{RageType|Number}}
*'''alpha?''': {{RageType|Number}}
*'''color''': {{RageType|[[Number, Number, Number], [Number, Number, Number]]}}
*'''color?''': {{RageType|[[Number, Number, Number], [Number, Number, Number]]}}
*'''locked''': {{RageType|Boolean}}
*'''locked?''': {{RageType|Boolean}}
*'''engine''': {{RageType|Boolean}}
*'''engine?''': {{RageType|Boolean}}
*'''dimension''': {{RageType|Number}}
*'''dimension?''': {{RageType|Number}}


== Examples ==
== Examples ==
Line 38: Line 35:
{{ClientsideCode|
{{ClientsideCode|
<pre>
<pre>
mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326),
mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326),  
     {
     {
         numberPlate: "ADMIN",
         numberPlate: "ADMIN",
Line 56: Line 53:
</pre>
</pre>
}}
}}
 
}}
==See also==
==See also==
'''Client Side'''
{{Vehicle_definition_c}}
{{Vehicle_definition_c}}


Line 64: Line 62:
[[Category:Client-side Function]]
[[Category:Client-side Function]]
[[Category:Shared Function]]
[[Category:Shared Function]]
'''Server Side'''
*Functions
{{Vehicle_functions}}
{{Entity_functions}}
*Properties
{{Vehicle_properties}}
{{Entity_properties}}

Latest revision as of 08:46, 29 May 2024

Shared
Function

 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]]
    });


See also

Client Side

Server Side