RAGE Multiplayer Wiki - User contributions [en]

Browser::url

2019-01-04T18:04:20Z

Flow: getter added

'''Function''': Set or get the url of a browser

==Parameters==
* '''URL''': {{RageType|String}}

==Syntax==
{{ClientsideCode|
<pre>
browser.url;
</pre>
}}

==Example==
Setter:
{{ClientsideCode|
<pre>
let browser = mp.browsers.new("package://index.html");
browser.url = "package://home.html";
</pre>
}}
Getter:
{{ClientsideCode|
<pre>
let url = browser.url;
</pre>
}}
See [[Package Protocol]] for more info on the <code>package://</code> url.

==See Also==
{{Browser_definition_c}}
[[Category:Clientside API]]

PlayerCreateWaypoint

2018-12-31T12:37:03Z

Flow:

'''DOES NOT SEEM TO WORK IN CURRENT 0.3.7 VERSION'''

Event triggered when a player creates a waypoint

==Parameters==
* '''player'''
* '''position''', Vector3 position of the waypoint

==Example==
<syntaxhighlight lang="javascript">
mp.events.add("playerCreateWaypoint", (player, position) => {
// Do what you want.
});
</syntaxhighlight>

Object::slide

2018-12-21T22:48:10Z

Flow:

Returns true if the object has finished moving. If false, moves the object towards the specified X, Y and Z coordinates with the specified X, Y and Z speed. See also: gtag.gtagaming.com/opcode-database/opcode/034E/ '''Has to be called in a render or it will not slide but move some amount and stop.'''
==Syntax==
<syntaxhighlight lang="javascript">object.slide(toX, toY, toZ, speedX, speedY, speedZ, collision);</syntaxhighlight>
=== Required Arguments ===
*'''toX:''' float
*'''toY:''' float
*'''toZ:''' float
*'''speedX:''' float
*'''speedY:''' float
*'''speedZ:''' float
*'''collision:''' Boolean
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
mp.events.add('render', () => {
object.slide(position.x, position.y, position.z, 1.0, 1.0, 1.0, false);
});
</syntaxhighlight>
==See also==
{{Object_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Object::slide

2018-12-21T22:47:53Z

Flow:

Returns true if the object has finished moving. If false, moves the object towards the specified X, Y and Z coordinates with the specified X, Y and Z speed. See also: gtag.gtagaming.com/opcode-database/opcode/034E/ '''Has to be called in a render or it will not slide but move some amount up and stop.'''
==Syntax==
<syntaxhighlight lang="javascript">object.slide(toX, toY, toZ, speedX, speedY, speedZ, collision);</syntaxhighlight>
=== Required Arguments ===
*'''toX:''' float
*'''toY:''' float
*'''toZ:''' float
*'''speedX:''' float
*'''speedY:''' float
*'''speedZ:''' float
*'''collision:''' Boolean
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
mp.events.add('render', () => {
object.slide(position.x, position.y, position.z, 1.0, 1.0, 1.0, false);
});
</syntaxhighlight>
==See also==
{{Object_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Object::slide

2018-12-21T22:46:59Z

Flow: has to be in render

Returns true if the object has finished moving. If false, moves the object towards the specified X, Y and Z coordinates with the specified X, Y and Z speed. See also: gtag.gtagaming.com/opcode-database/opcode/034E/ ***Has to be called in a render or it will not slide but move some amount up and stop.***
==Syntax==
<syntaxhighlight lang="javascript">object.slide(toX, toY, toZ, speedX, speedY, speedZ, collision);</syntaxhighlight>
=== Required Arguments ===
*'''toX:''' float
*'''toY:''' float
*'''toZ:''' float
*'''speedX:''' float
*'''speedY:''' float
*'''speedZ:''' float
*'''collision:''' Boolean
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
mp.events.add('render', () => {
object.slide(position.x, position.y, position.z, 1.0, 1.0, 1.0, false);
});
</syntaxhighlight>
==See also==
{{Object_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Object::getClosestObjectOfType

2018-12-21T22:41:42Z

Flow: returns object handle not object

Has 8 params in the latest patches. isMission - if true doesn't return mission objects
==Syntax==
<syntaxhighlight lang="javascript">mp.game.object.getClosestObjectOfType(x, y, z, radius, modelHash, isMission, p6, p7);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''radius:''' float
*'''modelHash:''' Model hash or name
*'''isMission:''' Boolean
*'''p6:''' Boolean
*'''p7:''' Boolean
===Return value===
*'''Object handle'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Object_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Useful clientside snippets

2018-12-21T09:51:01Z

Flow: added: disable health regenreation

Let's build a list with usesfull code snippets here.Remember: All of those are:
{{ClientSide}} 
==Get closest vehicle to your player==

<pre>
exports.closestVehicle= closestVehicle;
function closestVehicle(radius) {
let inRange = [];
let target = false;
mp.vehicles.forEach((_veh) => {
if(!_veh.handle) return false;
let distance = mp.game.gameplay.getDistanceBetweenCoords(_veh.position.x, _veh.position.y, _veh.position.z, mp.players.local.position.x, mp.players.local.position.y, mp.players.local.position.z, true);
if(distance > parseFloat(radius)) return false;
inRange.push({"remoteId": _veh.remoteId, "distance": distance});
});
if(inRange.length) {
inRange.sort(function(a, b) {
return a.distance-b.distance
});
target = mp.vehicles.atRemoteId(inRange[0].remoteId);
}
return target;
}
</pre>
==Return closest player to your local player position==
<pre>
exports.closestPlayer = closestPlayer;
function closestPlayer(radius) {
let inRange = [];
let target = false;
mp.players.forEach((_player) => {
if(_player == player) return false;
if(!_player.handle) return false;
let distance = mp.game.gameplay.getDistanceBetweenCoords(_player.position.x, _player.position.y, _player.position.z, mp.players.local.position.x, mp.players.local.position.y, mp.players.local.position.z, true);
if(distance > parseFloat(radius)) return false;
inRange.push({"remoteId": _player.remoteId, "distance": distance});
});
if(inRange.length) {
inRange.sort(function(a, b) {
return a.distance-b.distance
});
target = mp.players.atRemoteId(inRange[0].remoteId);
}
return target;
}
</pre>
== Check if player is driver==
<pre>
if (mp.players.local.vehicle && mp.players.local.vehicle.getPedInSeat(-1) === mp.players.local.handle) {
// player is in vehicle and is driver
}}
</pre>
== Disable health regeneration==
<pre>
mp.events.add('render', () => {
mp.game.player.setHealthRechargeMultiplier(0.0);
});
</pre>
[[Category:Clientside API]]
__FORCETOC__

Useful clientside snippets

2018-12-21T07:18:11Z

Flow:

Let's build a list with usesfull code snippets here.

==Get closest vehicle to your player==
{{ClientSide}}
<pre>
exports.closestVehicle= closestVehicle;
function closestVehicle(radius) {
let inRange = [];
let target = false;
mp.vehicles.forEach((_veh) => {
if(!_veh.handle) return false;
let distance = mp.game.gameplay.getDistanceBetweenCoords(_veh.position.x, _veh.position.y, _veh.position.z, mp.players.local.position.x, mp.players.local.position.y, mp.players.local.position.z, true);
if(distance > parseFloat(radius)) return false;
inRange.push({"remoteId": _veh.remoteId, "distance": distance});
});
if(inRange.length) {
inRange.sort(function(a, b) {
return a.distance-b.distance
});
target = mp.vehicles.atRemoteId(inRange[0].remoteId);
}
return target;
}
</pre>
==Return closest player to your local player position==
{{ClientSide}}
<pre>
exports.closestPlayer = closestPlayer;
function closestPlayer(radius) {
let inRange = [];
let target = false;
mp.players.forEach((_player) => {
if(_player == player) return false;
if(!_player.handle) return false;
let distance = mp.game.gameplay.getDistanceBetweenCoords(_player.position.x, _player.position.y, _player.position.z, mp.players.local.position.x, mp.players.local.position.y, mp.players.local.position.z, true);
if(distance > parseFloat(radius)) return false;
inRange.push({"remoteId": _player.remoteId, "distance": distance});
});
if(inRange.length) {
inRange.sort(function(a, b) {
return a.distance-b.distance
});
target = mp.players.atRemoteId(inRange[0].remoteId);
}
return target;
}
</pre>
== Check if player is driver==
{{ClientSide}}
<pre>
if (mp.players.local.vehicle && mp.players.local.vehicle.getPedInSeat(-1) === mp.players.local.handle) {
// player is in vehicle and is driver
}}
</pre>
[[Category:Clientside API]]
__FORCETOC__

Useful clientside snippets

2018-12-21T07:16:58Z

Flow: first commit

Vehicle::Vehicle

2018-12-21T06:58:26Z

Flow:

{{sharedFunctionJS}}

Creates a vehicle. 
'''Notes:''' Colors don't always work as expected if you use them inside the function. Also plate won't work propperly. Better set those after vehicle is created.

== Syntax ==

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

=== 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

{{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>
}}

Vehicle::Vehicle

2018-12-21T06:56:52Z

Flow: Hint for plate and color

{{sharedFunctionJS}}

Creates a vehicle.
'''Notes:''' Colors don't always work as expected if you use them inside the function. Also plate won't work propperly. Better set those after vehicle is created.

== Syntax ==

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

=== 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

{{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>
}}

Entity::setVariable

2018-12-21T06:52:26Z

Flow: mass setting not working - clarified

__NOTOC__
Set custom data to an entity.

==Syntax==
<pre>
// To set one variable at a time
entity.setVariable(name, value);

// To set multiple variables at a time.
entity.setVariable({name1: value1, name2: value2});
</pre>

==Example==
This binds the vehicle to the player
{{ServersideCode|
<pre>
let veh = mp.vehicles.new(vehName, player.position);
player.setVariable('veh', veh);
</pre>
}}

 
This is an example of setting multiple variables to a player which is '''not implemented and does not work (yet)'''
{{ServersideCode|
<pre>
player.setVariable({
name: 'Player',
age: 20
});
</pre>
}}

== See More ==
{{Entity_functions}}

Entity::data

2018-12-21T06:51:30Z

Flow: Clearification about setVariable and entity.data

This property is used to get or set entity data.

<del>'''FALSE''': Changing this property has the same effect as using [[Entity::setVariable|entity.setVariable]] function. </del>
'''TRUE''': if you use setVariable you have to use getVariable to get results. e.g. you can't do entity.setVariable('foo','bar') and get the result with entity.data.foo as getter. You can do so clientside, but not serverside.

== Property Type(s) & Attribute(s) ==
* Getter - attribute should be in '''any''' format.
* Setter - attribute should be in '''any''' format.

== Example(s) ==
{{ServerSide}}

The code below is an example about how to set a entity data by directly manipulating its "data" attribute.

<syntaxhighlight lang="javascript">
entity.data.foo = bar;
</syntaxhighlight>

Key::bind

2018-12-18T07:02:19Z

Flow:

This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keydown/keyup''' - true trigges on keydown, false triggers on keyup (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.
{{ClientSide}}
<syntaxhighlight lang="javascript">
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
mp.gui.chat.push('F2 key is pressed.');
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Key::bind

2018-12-18T07:01:54Z

Flow: /* Parameters */

This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keydown/keyup''' - true trigges on keydown, false triggers on keyup (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.
{{ClientSide}}
<syntaxhighlight lang="javascript">
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
mp.gui.chat.push('F2 key is pressed. This message will be shown until you release the key, because "keyhold" is true.');
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Key::bind

2018-12-18T07:00:35Z

Flow: /* Parameters */

This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keydown/keyup''' - true trigges on key down, false triggers on key up (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.
{{ClientSide}}
<syntaxhighlight lang="javascript">
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
mp.gui.chat.push('F2 key is pressed. This message will be shown until you release the key, because "keyhold" is true.');
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Key::bind

2018-12-18T07:00:24Z

Flow: Clearified that it's not keyhold but keyup and keydown

This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keydown/keyup''' - truetrigges on key down, false- triggers on key up (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.
{{ClientSide}}
<syntaxhighlight lang="javascript">
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
mp.gui.chat.push('F2 key is pressed. This message will be shown until you release the key, because "keyhold" is true.');
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Blip::setDisplay

2018-12-17T19:45:38Z

Flow:

displayId: 8 = shows on radar displayId: 3 = Shows on Main map but not Radar (not selectable on map) displayId: 2 = (Shows on Main map + Radar + selectable)
==Syntax==
<syntaxhighlight lang="javascript">blip.setDisplay(p1);</syntaxhighlight>
=== Required Arguments ===
*'''p1:''' int
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Blip_s_function_c}}
[[Category:Clientside API]]
[[Category:Blip API]]
[[Category:TODO: Example]]

Player::setComponentVariation

2018-12-17T18:40:47Z

Flow: Added example and wiki link to clothes

paletteId/palletColor - 0 to 3. enum PedVariationData { Player_VARIATION_FACE = 0, Player_VARIATION_HEAD = 1, Player_VARIATION_HAIR = 2, Player_VARIATION_TORSO = 3, Player_VARIATION_LEGS = 4, Player_VARIATION_HANDS = 5, Player_VARIATION_FEET = 6, Player_VARIATION_EYES = 7, Player_VARIATION_ACCESSORIES = 8, Player_VARIATION_TASKS = 9, Player_VARIATION_TEXTURES = 10, Player_VARIATION_TORSO2 = 11 }; Usage: SET_Player_COMPONENT_VARIATION(playerPed, Player_VARIATION_FACE, GET_NUMBER_OF_Player_DRAWABLE_VARIATIONS(playerPed, Player_VARIATION_FACE), GET_NUMBER_OF_Player_TEXTURE_VARIATIONS(playerPed, Player_VARIATION_FACE, 0), 2); List of component/props ID gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html See player clothes: https://wiki.rage.mp/index.php?title=Clothes
==Syntax==
<syntaxhighlight lang="javascript">player.setComponentVariation(componentId, drawableId, textureId, paletteId);</syntaxhighlight>
=== Required Arguments ===
*'''componentId:''' int
*'''drawableId:''' int
*'''textureId:''' int
*'''paletteId:''' int
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// set shirt on player
player.setComponentVariation(11, 4, 0, 2);
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]