Vehicle::Vehicle: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
 
(20 intermediate revisions by 13 users not shown)
Line 1: Line 1:
'''Function''': Creates a Vehicle.
{{sharedFunctionJS}}
Creates a vehicle in given position.


==Parameters==
{{JSContainer|
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]])
== Syntax ==
*'''position''': {{RageType|Vector3}}
<pre>
*'''heading''': {{RageType|Number}} [-180:180]
*'''numberPlate''': {{RageType|String}}
*'''alpha''': {{RageType|Number}}
*'''color''': {{RageType|undefined}} (need to be checked)
*'''locked''': {{RageType|Boolean}}
*'''engine''': {{RageType|Boolean}}
*'''dimension''': {{RageType|Number}}
 
==Syntax==
{{ServerSide}}
<syntaxhighlight lang="javascript">
mp.vehicles.new(model, position,
mp.vehicles.new(model, position,
{
{
Line 25: Line 15:
     dimension: dimension
     dimension: dimension
});
});
</syntaxhighlight>
</pre>
 
== Parameters ==
Note: Question marked parameters are optional.
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''position''': {{RageType|[[Vector3::Vector3|Vector3]]}}
*'''heading?''': {{RageType|Number}} [-180:180]
*'''numberPlate?''': {{RageType|String}}
*'''alpha?''': {{RageType|Number}}
*'''color?''': {{RageType|[[Number, Number, Number], [Number, Number, Number]]}}
*'''locked?''': {{RageType|Boolean}}
*'''engine?''': {{RageType|Boolean}}
*'''dimension?''': {{RageType|Number}}
 
== Examples ==
 
An example of creating a red Turismo with the license plate ADMIN
 
{{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}}

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