RAGE Multiplayer Wiki - User contributions [en]

Player::applyDamageTo

2023-01-09T11:23:30Z

KirillZver: /* Syntax */

==Syntax==
<syntaxhighlight lang="javascript">player.applyDamageTo(damageAmount, includingArmor);</syntaxhighlight>
=== Required Arguments ===
*'''damageAmount:''' int
*'''includingArmor:''' Boolean
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
// player health: 100, armor: 100

player.applyDamageTo(25, false);
// player health: 75, armor: 100

player.applyDamageTo(25, true);
// player health: 75, armor: 75
</syntaxhighlight>

==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::applyDamageTo

2023-01-09T11:22:20Z

KirillZver: /* Example */

==Syntax==
<syntaxhighlight lang="javascript">player.applyDamageTo(damageAmount, withArmor);</syntaxhighlight>
=== Required Arguments ===
*'''damageAmount:''' int
*'''withArmor:''' Boolean
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
// player health: 100, armor: 100

player.applyDamageTo(25, false);
// player health: 75, armor: 100

player.applyDamageTo(25, true);
// player health: 75, armor: 75
</syntaxhighlight>

==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::applyDamageTo

2023-01-09T11:21:52Z

KirillZver: /* Example */

==Syntax==
<syntaxhighlight lang="javascript">player.applyDamageTo(damageAmount, withArmor);</syntaxhighlight>
=== Required Arguments ===
*'''damageAmount:''' int
*'''withArmor:''' Boolean
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
// player health: 100, armor: 100
player.applyDamageTo(25, false);
// player health: 75, armor: 100
player.applyDamageTo(25, true);
// player health: 75, armor: 75
</syntaxhighlight>

==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Player::applyDamageTo

2023-01-09T11:20:01Z

KirillZver: /* Syntax */

==Syntax==
<syntaxhighlight lang="javascript">player.applyDamageTo(damageAmount, withArmor);</syntaxhighlight>
=== Required Arguments ===
*'''damageAmount:''' int
*'''withArmor:''' Boolean
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Browser::url

2021-02-06T20:05:42Z

KirillZver:

'''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>
}}
Note that after changing url, caret disappears in active input (tested in 1.1).

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

Browser::url

2021-02-06T20:05:31Z

KirillZver:

'''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>
}}
Note that after changing url, caret disappears in active input (tested in 1.1).
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]]

Camera::Camera

2021-01-26T01:01:54Z

KirillZver: Undo revision 20521 by KirillZver (talk)

__NOTOC__
Creates a camera.

==Syntax==
<pre>
mp.cameras.new(name, position, rotation, fov);
</pre>

==Parameters==
*'''name''': {{RageType|String}}
*'''position''': {{RageType|Vector3}}
*'''rotation''': {{RageType|Vector3}}
*'''fov''': {{RageType|Int}}

==Examples==
Creates a camera and sets it to look towards a location.
 
 
Version 0.3.7:
{{ClientsideCode|
<pre>
let sceneryCamera = mp.cameras.new('default', new mp.Vector3(-485, 1095.75, 323.85), new mp.Vector3(0,0,0), 40);

sceneryCamera.pointAtCoord(402.8664, -996.4108, -98.5); // Changes the rotation of the camera to point towards a location
sceneryCamera.setActive(true);
mp.game.cam.renderScriptCams(true, false, 0, true, false);
</pre>
}}
 
Version 1.1:
{{ClientsideCode|
<pre>
sceneryCamera.pointAtCoord(402.8664, -996.4108, -98.5); // PointAtCoord can't use Vector3 position in version 1.1. Use position.x, position.y, position.z instead.
</pre>
}}

==See Also==
{{Camera_definition_c}}
[[Category:Clientside API]]
[[Category:Camera API]]

Vehicle::getNumMods

2021-01-26T01:01:27Z

KirillZver:

Returns how many possible mods a vehicle has for a given mod type.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getNumMods(modType);</syntaxhighlight>
=== Required Arguments ===
*'''modType:''' int
===Return value===
*'''int'''
==Example==
{{ClientsideCode|
<pre>
mp.players.local.vehicle.getNumMods(48); // get the number of vinyls for the car in which the player sits
</pre>
}}
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Camera::Camera

2021-01-26T01:00:58Z

KirillZver:

__NOTOC__
Creates a camera.

==Syntax==
<pre>
mp.cameras.new(name, position, rotation, fov);
</pre>

==Parameters==
*'''name''': {{RageType|String}}
*'''position''': {{RageType|Vector3}}
*'''rotation''': {{RageType|Vector3}}
*'''fov''': {{RageType|Int}}

==Examples==
Creates a camera and sets it to look towards a location.
 
 
Version 0.3.7:
{{ClientsideCode|
<pre>
let sceneryCamera = mp.cameras.new('default', new mp.Vector3(-485, 1095.75, 323.85), new mp.Vector3(0,0,0), 40);

sceneryCamera.pointAtCoord(402.8664, -996.4108, -98.5); // Changes the rotation of the camera to point towards a location
sceneryCamera.setActive(true);
mp.game.cam.renderScriptCams(true, false, 0, true, false);
</pre>
}}
 
{{ClientsideCode|
<pre>
mp.players.local.vehicle.getNumMods(48); // get the number of vinyls for the car in which the player sits
</pre>
}}

==See Also==
{{Camera_definition_c}}
[[Category:Clientside API]]
[[Category:Camera API]]

Entity::getOwnVariable

2021-01-02T00:56:48Z

KirillZver:

__TOC__

{{ServersideJsFunction}}

Allows to get the value set with [[Entity::setOwnVariable|entity.setOwnVariable(key, value)]].

Позволяет получить значение установленное с помощью [[Entity::setOwnVariable|entity.setOwnVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.getOwnVariable(key);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''key''': {{RageType|String}}

==Example==
This will set the job id for this player, which will only be available to him.

Это установит id работы для данного игрока, которое будет доступно только у него.
{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
So we get the value that we set earlier.

Так мы получим значение, что установили ранее.
{{ServersideCode|
<pre>
player.getOwnVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Entity::getOwnVariable

2021-01-02T00:55:26Z

KirillZver: Created page with "__TOC__ {{ServersideJsFunction}} Allows to get the value set with entity.setOwnVariable(key, value). Позволяет получить знач..."

__TOC__

{{ServersideJsFunction}}

Allows to get the value set with [[Entity::setOwnVariable|entity.setOwnVariable(key, value)]].

Позволяет получить значение установленное с помощью [[Entity::setOwnVariable|entity.setOwnVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.getOwnVariable(key);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''key''': {{RageType|String}}

==Example==
This will set the job id for this player, which will only be available to him.

Это установит id работы для данного игрока, которое будет доступно только у него.
{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
{{ServersideCode|
<pre>
player.getOwnVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Entity::setOwnVariable

2021-01-02T00:51:11Z

KirillZver:

__TOC__

{{ServersideJsFunction}}

Sets the data available to the player as opposed to [[Entity::setVariable|entity.setVariable(key, value)]].

Устанавливает для игрока данные, которые доступны ему, в отличии от [[Entity::setVariable|entity.setVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.setOwnVariable(key, value);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''key''': {{RageType|String}}
*{{Required}}'''value''': {{RageType|Any}}

==Example==
This will set the job id for this player, which will only be available to him.

Это установит id работы для данного игрока, которое будет доступно только у него.
{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
{{ClientsideCode|
<pre>
mp.players.local.getVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Entity::setOwnVariable

2021-01-02T00:50:43Z

KirillZver:

__TOC__

{{ServersideJsFunction}}

Sets the data available to the player as opposed to [[Entity::setVariable|entity.setVariable(key, value)]].

Устанавливает для игрока данные, которые доступны ему, в отличии от [[Entity::setVariable|entity.setVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.setOwnVariable(key, value);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''name''': {{RageType|String}}
*{{Required}}'''value''': {{RageType|Any}}

==Example==
This will set the job id for this player, which will only be available to him.

Это установит id работы для данного игрока, которое будет доступно только у него.
{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
{{ClientsideCode|
<pre>
mp.players.local.getVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Entity::setOwnVariable

2021-01-02T00:50:24Z

KirillZver: Created page with "__TOC__ {{ServersideJsFunction}} Sets the data available to the player as opposed to entity.setVariable(key, value). Устанавливает дл..."

__TOC__

{{ServersideJsFunction}}

Sets the data available to the player as opposed to [[Entity::setVariable|entity.setVariable(key, value)]].
Устанавливает для игрока данные, которые доступны ему, в отличии от [[Entity::setVariable|entity.setVariable(key, value)]].

{{JSContainer|
==Syntax==
<pre>
entity.setOwnVariable(key, value);
</pre>

=== Required Arguments ===
*{{Required}}'''entity''': {{RageType|Object}}
*{{Required}}'''name''': {{RageType|String}}
*{{Required}}'''value''': {{RageType|Any}}

==Example==
This will set the job id for this player, which will only be available to him.
Это установит id работы для данного игрока, которое будет доступно только у него.
{{ServersideCode|
<pre>
player.setOwnVariable("jobId", 9);
</pre>
}}

 
{{ClientsideCode|
<pre>
mp.players.local.getVariable("jobId"); // 9
</pre>
}}
}}

== See More ==
{{Entity_functions}}

[[Category:Entity API]]
[[Category:Server-side Function]]

Template:Entity functions

2021-01-02T00:32:19Z

KirillZver:

**[[Entity::destroy]]
**[[Entity::dist]]
**[[Entity::distSquared]]
**[[Entity::getVariable]]
**[[Entity::getOwnVariable]]
**[[Entity::setVariable]]
**[[Entity::setOwnVariable]]
**[[Entity::setOwnVariables]]
**[[Entity::setVariables]]

Template:Entity functions

2021-01-02T00:31:48Z

KirillZver:

Weapons::clear

2021-01-01T17:23:17Z

KirillZver:

Removes all weapons from the player. Analog [[Player::removeAllWeapons|player.removeAllWeapons()]]

Удаляет всё оружие игрока. Аналог [[Player::removeAllWeapons|player.removeAllWeapons()]]

== Syntax ==

<pre>
player.weapons.clear();
</pre>

== See Also ==
{{Player_block}}

Weapons::clear

2021-01-01T17:22:27Z

KirillZver: Created page with "Removes all weapons from the player. Analog player.removeAllWeapons() Удаляет всё оружие игрока. Аналог Player::rem..."

Getting Started with Events

2020-12-20T14:48:39Z

KirillZver: /* Registering an event */

== Introduction ==

Events are the core scripting system for RAGE:MP. They are registered upon your request and triggered in a certain situation, For example, [[PlayerEnterCheckpoint|PlayerEnterCheckpoint]] triggers when a player enters a checkpoint, so the event is automatically triggered and returns for you the '''Player''' that entered the checkpoint and the '''Checkpoint''' that he entered.

== Events system ==

In-order to use the events you need to register the event into the events tree using [[Events::add|addEvent]]. 
There are 2 types of '''Events''':
*Built in events
*Custom events

=== Built in events ===

They are events provided by '''RAGE:MP''' to be auto-triggered in a certain situation as we mentioned in the beginning (a '''Player''' entering a '''Checkpoint'''). 

These are listed on the following pages:
*[[Server-side_events|Server-side events]]
*[[Client-side_events|Client-side events]]

=== Custom events ===

They are events build for you to control/call them anytime you want and in any situation you create for the '''Player'''. 

== Using events ==

=== Registering an event ===

You always have to register an event to the events tree before using it anywhere. 

Registering it is pretty simple, but you have to keep in mind in which area it'll be called. 

if your event will be for server-side use only then you can register it the way you want.

{{ServersideCode|
<pre>
mp.events.add('eventName', (arg1, arg2, etc.) => {
// code
});
</pre>
}}

if your event will be called from client-side and you registered it in server-side. You have to add '''player''' argument as a main first argument because client-side delivers the localPlayer with your data, so you can know which player is it.

{{ServersideCode|
<pre>
mp.events.add('eventName', (player, arg1, arg2, etc.) => {
// code
});
</pre>
}}

In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.

In 1.1 version:

Added: CEF: mp.events.add(string eventName, function handler)

Added: CEF: mp.events.reset()

Added: CEF: mp.events.remove(string eventName)

Added: CEF: mp.events.call(string eventName) (псевдоним к mp.trigger)

Added: Client-side: Browser.call(eventName, arguments...)

== Calling methods ==

It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.
{{JSContainer|
===Calling server-side or client-side local events===
====Syntax====
<pre>
mp.events.call('eventName', args);
</pre>
===Calling client-side events from server-side (the server-side calls client-side)===
Notice: arguments must be inside an array.
====Make a player call their client-side====
=====Syntax=====
<pre>
player.call('eventName', [arg1, arg2]);
</pre>
=====Examples=====
======Example 1======
With this example we'll add a server-side command that calls a client-side event that starts a screen effect on the player who types the command.
As show below, once a player types /effect [effect] (for example, /effect ChopVision) it will send whatever the player typed on the first argument to the event created on the client-side ('startEffectEvent').
{{ServersideCode|
<pre>
mp.events.addCommand('effect', (player, fullText, effect) => {
player.call('startEffectEvent', [effect]);
});
</pre>
}}
On the client-side, it will received whatever the player typed on the first argument and replace it on the effect.
{{ClientsideCode|
<pre>
mp.events.add('startEffectEvent', (effect) => {
mp.game.graphics.startScreenEffect(effect, 10000, false);
});
</pre>
}}
====Make all players in the server call their client-side====
=====Syntax=====
<pre>
mp.players.call('eventName', [arg1, arg2]);
</pre>
====Make server-side call a filtered player's client-side====
The example below filters a player with the name '''WeirdNewbie''' to call his client-side.
=====Syntax=====
<pre>
mp.players.call(mp.players.toArray().filter((_player) => _player.name == 'WeirdNewbie'), 'eventName', [args]);
</pre>
===Calling server-side events from client-side (the client-side calls server-side)===
====Syntax====
<pre>
mp.events.callRemote('eventName', args);
</pre>
===Calling a function registered in CEF from client-side (the client-side calls CEF)===
====Syntax====
<pre>
mbrowser.execute(´javascriptFunction('${variable1}','${variable2}');´);
</pre>
===Calling a client-side event from CEF (the CEF calls client-side)===
Notice: You can't communicate between CEF and server-side
====Syntax====
<pre>
mp.trigger('eventName', args);
</pre>
}}

== Cancelling events ==

There are 2 ways to cancel a event:
*Pausing it for future use.
*Removing it from events tree.

=== Pausing ===

In-order to pause a event you are required to use a special function to add that event ([[Events::Event|mp.Event]]). 
A small example of how to use it:

{{ServersideCode|
<pre>
let ev = new mp.Event("playerDeath", (player, reason, killer) =>
{
mp.players.broadcast('First blood!');
ev.destroy(); // this event handler will be not called anymore since it's destroyed
});
// ev.enable(); due to this line the event will be re-enabled.
// ev.destroy(); due to this line the event is never going to be executed if we call this before it
</pre>
}}

=== Removing ===

Here are all the methods to remove events:

{{SharedCode|
<pre>
// Remove specified handler of specified event
function playerJoinHandler(player)
{

}

mp.events.add("playerJoin", playerJoinHandler);
mp.events.remove("playerJoin", playerJoinHandler);

// Remove handler(s) specified event(s)
mp.events.remove("playerJoin");
mp.events.remove(["playerJoin", "playerQuit"]);

// Reset whole event tree.
mp.events.reset();

// Get all handlers of specified event
mp.events.getAllOf("playerJoin").forEach(_ev => _ev(null));
</pre>
}}

== See also ==
{{ScriptingTutorials}}

[[Category:Tutorials]]

Getting Started with Events

2020-12-20T14:48:03Z

KirillZver: /* Registering an event */

== Introduction ==

Events are the core scripting system for RAGE:MP. They are registered upon your request and triggered in a certain situation, For example, [[PlayerEnterCheckpoint|PlayerEnterCheckpoint]] triggers when a player enters a checkpoint, so the event is automatically triggered and returns for you the '''Player''' that entered the checkpoint and the '''Checkpoint''' that he entered.

== Events system ==

In-order to use the events you need to register the event into the events tree using [[Events::add|addEvent]]. 
There are 2 types of '''Events''':
*Built in events
*Custom events

=== Built in events ===

They are events provided by '''RAGE:MP''' to be auto-triggered in a certain situation as we mentioned in the beginning (a '''Player''' entering a '''Checkpoint'''). 

These are listed on the following pages:
*[[Server-side_events|Server-side events]]
*[[Client-side_events|Client-side events]]

=== Custom events ===

They are events build for you to control/call them anytime you want and in any situation you create for the '''Player'''. 

== Using events ==

=== Registering an event ===

You always have to register an event to the events tree before using it anywhere. 

Registering it is pretty simple, but you have to keep in mind in which area it'll be called. 

if your event will be for server-side use only then you can register it the way you want.

{{ServersideCode|
<pre>
mp.events.add('eventName', (arg1, arg2, etc.) => {
// code
});
</pre>
}}

if your event will be called from client-side and you registered it in server-side. You have to add '''player''' argument as a main first argument because client-side delivers the localPlayer with your data, so you can know which player is it.

{{ServersideCode|
<pre>
mp.events.add('eventName', (player, arg1, arg2, etc.) => {
// code
});
</pre>
}}

In '''CEF''' you're not allowed to register any events. You can only call the functions that are registered in your '''CEF'''.
In 1.1 version:
Added: CEF: mp.events.add(string eventName, function handler)
Added: CEF: mp.events.reset()
Added: CEF: mp.events.remove(string eventName)
Added: CEF: mp.events.call(string eventName) (псевдоним к mp.trigger)
Added: Client-side: Browser.call(eventName, arguments...)

== Calling methods ==

It is pretty important to know how to call your events on each side, or you'll be totally lost in your development. We made it easier for you with the following calling methods, so you can know how the events calling system is working.
{{JSContainer|
===Calling server-side or client-side local events===
====Syntax====
<pre>
mp.events.call('eventName', args);
</pre>
===Calling client-side events from server-side (the server-side calls client-side)===
Notice: arguments must be inside an array.
====Make a player call their client-side====
=====Syntax=====
<pre>
player.call('eventName', [arg1, arg2]);
</pre>
=====Examples=====
======Example 1======
With this example we'll add a server-side command that calls a client-side event that starts a screen effect on the player who types the command.
As show below, once a player types /effect [effect] (for example, /effect ChopVision) it will send whatever the player typed on the first argument to the event created on the client-side ('startEffectEvent').
{{ServersideCode|
<pre>
mp.events.addCommand('effect', (player, fullText, effect) => {
player.call('startEffectEvent', [effect]);
});
</pre>
}}
On the client-side, it will received whatever the player typed on the first argument and replace it on the effect.
{{ClientsideCode|
<pre>
mp.events.add('startEffectEvent', (effect) => {
mp.game.graphics.startScreenEffect(effect, 10000, false);
});
</pre>
}}
====Make all players in the server call their client-side====
=====Syntax=====
<pre>
mp.players.call('eventName', [arg1, arg2]);
</pre>
====Make server-side call a filtered player's client-side====
The example below filters a player with the name '''WeirdNewbie''' to call his client-side.
=====Syntax=====
<pre>
mp.players.call(mp.players.toArray().filter((_player) => _player.name == 'WeirdNewbie'), 'eventName', [args]);
</pre>
===Calling server-side events from client-side (the client-side calls server-side)===
====Syntax====
<pre>
mp.events.callRemote('eventName', args);
</pre>
===Calling a function registered in CEF from client-side (the client-side calls CEF)===
====Syntax====
<pre>
mbrowser.execute(´javascriptFunction('${variable1}','${variable2}');´);
</pre>
===Calling a client-side event from CEF (the CEF calls client-side)===
Notice: You can't communicate between CEF and server-side
====Syntax====
<pre>
mp.trigger('eventName', args);
</pre>
}}

== Cancelling events ==

There are 2 ways to cancel a event:
*Pausing it for future use.
*Removing it from events tree.

=== Pausing ===

In-order to pause a event you are required to use a special function to add that event ([[Events::Event|mp.Event]]). 
A small example of how to use it:

{{ServersideCode|
<pre>
let ev = new mp.Event("playerDeath", (player, reason, killer) =>
{
mp.players.broadcast('First blood!');
ev.destroy(); // this event handler will be not called anymore since it's destroyed
});
// ev.enable(); due to this line the event will be re-enabled.
// ev.destroy(); due to this line the event is never going to be executed if we call this before it
</pre>
}}

=== Removing ===

Here are all the methods to remove events:

{{SharedCode|
<pre>
// Remove specified handler of specified event
function playerJoinHandler(player)
{

}

mp.events.add("playerJoin", playerJoinHandler);
mp.events.remove("playerJoin", playerJoinHandler);

// Remove handler(s) specified event(s)
mp.events.remove("playerJoin");
mp.events.remove(["playerJoin", "playerQuit"]);

// Reset whole event tree.
mp.events.reset();

// Get all handlers of specified event
mp.events.getAllOf("playerJoin").forEach(_ev => _ev(null));
</pre>
}}

== See also ==
{{ScriptingTutorials}}

[[Category:Tutorials]]

Player::setHeadOverlay

2020-11-24T16:33:52Z

KirillZver:

OverlayID ranges from 0 to 12, index from 0 to _GET_NUM_OVERLAY_VALUES(overlayID)-1, and opacity from 0.0 to 1.0. 
First and second color you can take in the list of hair colors. 
List of colors: https://wiki.gtanet.work/index.php?title=Hair_Colors
 
{| class="wikitable"

| OverlayID
| Part
| Index
|-

| 0
| Blemishes
| 0-23
|-

| 1
| Facial Hair
| 0-28
|-

| 2
| Eyebrows
| 0-33
|-

| 3
| Ageing
| 0-14
|-

| 4
| Makeup
| 0-74
|-

| 5
| Blush
| 0-32
|-

| 6
| Complexion
| 0-11
|-

| 7
| Sun Damage
| 0-10
|-

| 8
| Lipstick
| 0-9
|-

| 9
| Moles/Freckles
| 0-17
|-

| 10
| Chest Hair
| 0-16
|-

| 11
| Body Blemishes
| 0-11
|-

| 12
| Add Body Blemishes
| 0-1
|-

|}

To disable any overlay use 255 as index.

==Syntax==
{{ClientsideCode|
<pre>
player.setHeadOverlay(overlayID, index, opacity, firstColor, secondColor);

// The variation of this function for peds (mp.peds) does not take values to set the overlay color. It uses the syntax used in the native.
ped.setHeadOverlay(overlayID, index, opacity);
</pre>
}}

{{ServersideCode|
<pre>
player.setHeadOverlay(overlayID, [index, opacity, firstColor, secondColor]);
</pre>
}}
=== Required Arguments ===
*'''overlayID:''' int
*'''index:''' int
*'''opacity:''' float
*'''firstColor:''' int
*'''secondColor:''' int
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="cs">
C# Serverside Example

private static readonly string[] headOverlayNames = { "blemishes", "facialHair", "eyebrows", "ageing", "makeup", "blush", "complexion", "sunDamage", "lipstick", "molesFreckles", "chestHair", "bodyBlemishes", "addBodyBlemishes" };

private static HeadOverlay CreateHeadOverlay(Byte index, Byte color, Byte secondaryColor, float opacity)
{
return new HeadOverlay
{
Index = index,
Color = color,
SecondaryColor = secondaryColor,
Opacity = opacity
};
}

[Command("beard")]
public void Beard(Client c, byte Index, byte Color, byte SeconardyColor, byte Opacity)
{
Dictionary<int, HeadOverlay> headOverlays = new Dictionary<int, HeadOverlay>();
headOverlays.Add(1, CreateHeadOverlay((byte)Index, (byte)Color, (byte)SeconardyColor, (byte)Opacity));
c.SetHeadOverlay(1, headOverlays[1]);
}

Testexamples use Command:
beard 1 0 0 1 = Set beard 1 with PrimaryColor 0 SecondardyColor 0 and opacity 1 (use opacity 0 for invisible, 1 for full visible)
beard 2 22 0 1 = Set beard 1 with PrimaryColor 22(red) SecondardyColor 0 and opacity 1 (use opacity 0 for invisible, 1 for full visible)
Restriction: Command can just handle 0, 1 on opacity but it is a byte and can have a value from 0.0 - 1.0

</syntaxhighlight>

==See also==
{{Player_function_c}}

[[Category:Player Appearance]]
[[Category:Clientside API]]
[[Category:TODO: Example]]
[[Category:Server-side Function]]
[[Category:Client-side Function]]

Graphics::transitionFromBlurred

2020-11-13T14:41:07Z

KirillZver:

Time in ms to transition from fully blurred to normal. RU: время в мс для перехода от полностью размытого экрана до нормального
==Syntax==
<syntaxhighlight lang="javascript">mp.game.graphics.transitionFromBlurred(transitionTime);</syntaxhighlight>
=== Required Arguments ===
*'''transitionTime:''' float
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
mp.game.graphics.transitionFromBlurred(1000); // Remove blur completely after 1000 ms (RU: Полностью убираем размытие через 1000 мс)
</syntaxhighlight>
==See also==
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Graphics::transitionToBlurred

2020-11-13T14:39:09Z

KirillZver:

Time in ms to transition to fully blurred screen.
RU: время в мс до перехода к полностью размытому экрану.
==Syntax==
<syntaxhighlight lang="javascript">mp.game.graphics.transitionToBlurred(transitionTime);</syntaxhighlight>
=== Required Arguments ===
*'''transitionTime:''' float
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
mp.game.graphics.transitionToBlurred(1000); // Blur the screen after 1000ms (RU: Размываем экран через 1000 мс)
</syntaxhighlight>

==See also==
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Graphics::transitionToBlurred

2020-11-13T14:38:15Z

KirillZver: /* Example */

time in ms to transition to fully blurred screen
==Syntax==
<syntaxhighlight lang="javascript">mp.game.graphics.transitionToBlurred(transitionTime);</syntaxhighlight>
=== Required Arguments ===
*'''transitionTime:''' float
===Return value===
*'''Boolean'''
==Example==
<syntaxhighlight lang="javascript">
mp.game.graphics.transitionToBlurred(1000); // Blur the screen after 1000ms (RU: Размываем экран через 1000 мс)
</syntaxhighlight>

==See also==
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Events::callRemoteProc

2020-11-04T11:05:43Z

KirillZver:

This function calls a previously registered event on the server using [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].

Эта функция вызывает ранее зарегистрированное событие на сервере с помощью [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].

==Syntax==
<pre>
mp.events.callRemoteProc(String eventName [, ...args])
</pre>

==Example==
In this example, we will send an RPC request from the client to the server in which we will transmit the number 1. We will wait for the response and process it.
On the server, if number is 1, return true, otherwise false.
P.S. Note that await can only be used in an async function.

В данном примере мы отправим RPC запрос с клиента на сервер в котором передадим число 1. Дождёмся ответа и обработаем его.
На сервере, если number равен 1 вернём true, в остальных случаях false.
P.S. Обратите внимание, что использовать await можно лишь в async функции.

{{ClientsideCode|
<pre>
const number = 1;
const response = await mp.events.callRemoteProc("testEvent", number);
if (response.result === true) mp.console.logInfo("Result is true", true, true);
</pre>
}}

{{ServersideCode|
<pre>
mp.events.addProc("testEvent", (number) => {
return {
result: number === 1 ? true : false
};
});
</pre>
}}

==See Also==
{{Event_functions}}

Events::callRemoteProc

2020-11-04T11:05:21Z

KirillZver: /* Example */

This function calls a previously registered event on the server using [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].
Эта функция вызывает ранее зарегистрированное событие на сервере с помощью [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].

==Syntax==
<pre>
mp.events.callRemoteProc(String eventName [, ...args])
</pre>

==Example==
In this example, we will send an RPC request from the client to the server in which we will transmit the number 1. We will wait for the response and process it.
On the server, if number is 1, return true, otherwise false.
P.S. Note that await can only be used in an async function.

В данном примере мы отправим RPC запрос с клиента на сервер в котором передадим число 1. Дождёмся ответа и обработаем его.
На сервере, если number равен 1 вернём true, в остальных случаях false.
P.S. Обратите внимание, что использовать await можно лишь в async функции.

{{ClientsideCode|
<pre>
const number = 1;
const response = await mp.events.callRemoteProc("testEvent", number);
if (response.result === true) mp.console.logInfo("Result is true", true, true);
</pre>
}}

{{ServersideCode|
<pre>
mp.events.addProc("testEvent", (number) => {
return {
result: number === 1 ? true : false
};
});
</pre>
}}

==See Also==
{{Event_functions}}

Events::callRemoteProc

2020-11-04T11:04:56Z

KirillZver: Created page with " This function calls a previously registered event on the server using [[Events::addProc|mp.events.addProc(String eventName [, ...args])]]. Эта функция вызыва..."

This function calls a previously registered event on the server using [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].
Эта функция вызывает ранее зарегистрированное событие на сервере с помощью [[Events::addProc|mp.events.addProc(String eventName [, ...args])]].

==Syntax==
<pre>
mp.events.callRemoteProc(String eventName [, ...args])
</pre>

==Example==
In this example, we will send an RPC request from the client to the server in which we will transmit the number 1. We will wait for the response and process it.
On the server, if number is 1, return true, otherwise false.
P.S. Note that await can only be used in an async function.
В данном примере мы отправим RPC запрос с клиента на сервер в котором передадим число 1. Дождёмся ответа и обработаем его.
На сервере, если number равен 1 вернём true, в остальных случаях false.
P.S. Обратите внимание, что использовать await можно лишь в async функции.

{{ClientsideCode|
<pre>
const number = 1;
const response = await mp.events.callRemoteProc("testEvent", number);
if (response.result === true) mp.console.logInfo("Result is true", true, true);
</pre>
}}

{{ServersideCode|
<pre>
mp.events.addProc("testEvent", (number) => {
return {
result: number === 1 ? true : false
};
});
</pre>
}}

==See Also==
{{Event_functions}}

World::requireIpl

2020-10-30T20:03:45Z

KirillZver:

__TOC__

{{ServersideJsFunction}}

This function require an IPL and sync it to every client.

{{JSContainer|
== Syntax ==
<pre>mp.world.requestIpl(ipl);</pre>

== Required Arguments ==
* {{Required}}'''ipl''': {{RageType|String}} ([[Interiors_and_Locations|IPLs]])

==Example==
{{ServersideCode|
<pre>
mp.world.requestIpl("gr_case10_bunkerclosed"); // THIS ADDS THE BUNKER ENTRANCE NEAR ZANCUDO. POSITION: (-3058.714, 3329.19, 12.5844)
</pre>
}}
}}

==See Also==
{{World_definition}}

Ui::isPauseMenuActive

2020-10-22T14:23:13Z

KirillZver: /* Example */

==Syntax==
<pre>mp.game.ui.isPauseMenuActive();</pre>

=== Information ===
Determine if the front end pause menu is currently active. Ie. the options menu.

===Return value===
*'''true/false'''
==Example==
<pre>
let isPauseActive = mp.game.ui.isPauseMenuActive();
</pre>

==See also==
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:UI API]]

Player::playScenario

2020-10-16T16:35:11Z

KirillZver: /* Example */

This function makes the player play a scenario. [[Scenarios|Scenario List]]

==Parameters==
<pre>player.playScenario(scenarioName);</pre>

* '''scenario: String'''

==Syntax==
{{ServersideCode|
<pre>
player.playScenario(scenario)
</pre>
}}

==Example==
{{ServersideCode|
<pre>
player.playScenario("WORLD_HUMAN_PAPARAZZI");
</pre>
}}
This example will run an Paparazzi Scenario.

==See Also==
{{Player_block}}
[[Category:TODO: Example]]

Player::playScenario

2020-10-16T16:35:05Z

KirillZver: /* Syntax */

This function makes the player play a scenario. [[Scenarios|Scenario List]]

==Parameters==
<pre>player.playScenario(scenarioName);</pre>

* '''scenario: String'''

==Syntax==
{{ServersideCode|
<pre>
player.playScenario(scenario)
</pre>
}}

==Example==
{{ServersideCode|
<pre>
player.PlayScenario("WORLD_HUMAN_PAPARAZZI");
</pre>
}}
This example will run an Paparazzi Scenario.

==See Also==
{{Player_block}}
[[Category:TODO: Example]]

Player::playScenario

2020-10-16T16:34:58Z

KirillZver: /* Parameters */

This function makes the player play a scenario. [[Scenarios|Scenario List]]

==Parameters==
<pre>player.playScenario(scenarioName);</pre>

* '''scenario: String'''

==Syntax==
{{ServersideCode|
<pre>
player.PlayScenario(scenario)
</pre>
}}

==Example==
{{ServersideCode|
<pre>
player.PlayScenario("WORLD_HUMAN_PAPARAZZI");
</pre>
}}
This example will run an Paparazzi Scenario.

==See Also==
{{Player_block}}
[[Category:TODO: Example]]