Vehicle::Vehicle: Difference between revisions

From RAGE Multiplayer Wiki
(Created examples & changed layout)
Line 1: Line 1:
'''Function''': Creates a Vehicle.
{{Shared}}
 
Creates a vehicle.


==Parameters==
== Syntax ==
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''position''': {{RageType|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}}


==Syntax==
{{Shared}}
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.vehicles.new(model, position,
mp.vehicles.new(model, position,
Line 26: Line 17:
});
});
</syntaxhighlight>
</syntaxhighlight>
=== Parameters ===
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''position''': {{RageType|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
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326),
    {
        numberPlate: "ADMIN",
        color: [[255, 0, 0],[255,0,0]]
    });
</syntaxhighlight>
</div>
Same example but creating a blue Turismo and using it server-side
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
mp.vehicles.new(mp.joaat("turismor"), new mp.Vector3(-441.88, 1156.86, 326),
    {
        numberPlate: "ADMIN",
        color: [[0, 255, 0],[0, 255, 0]]
    });
</syntaxhighlight>
</div>

Revision as of 00:35, 12 May 2018

Shared

Creates a vehicle.

Syntax

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

Parameters

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