RAGE Multiplayer Wiki - User contributions [en]

Server settings

2017-12-31T15:19:08Z

TempletonPeck:

* '''conf.json -''' is a configuration file which allows you manage your server easily.

== Settings ==
The following table will explain the use of the following settings:

{| class="wikitable"
|-
! Setting !! Default value !! Description
|-
| announce || false || Announce to the master server so people can see you in their server browser.
|-
| bind|| 127.0.0.1 || The IP to listen to.
|-
| gamemode|| Freeroam || The server's gamemode.
|-
| encryption|| false|| ...
|-
| maxplayers || 100 || Maximum number of players your server will hold.
|-
| name || RAGE:MP Unofficial server || Server name that will be displayed to the master server.
|-
| stream-distance || 500.0 || The distance on the X,Y plane which server entities will stream in for connected players.
|-
| port || 22005 || The port that the server will use. The server uses both UDP and TCP protocols.<br/>The port after that one (''port + 1'', so 22006 by default) will be used for the HTTP server that hosts the client packages for the clients to download from.
|-
| disallow-multiple-connections-per-ip|| false|| ...
|-
| limit-time-of-connections-per-ip|| 0|| ...
|-
| url|| || Website URL.
|-
| language|| en|| Server's language
|-
| sync-rate|| 40|| ...
|-
| resource-scan-thread-limit|| || ...
|-
| max-ping|| || Maximum Ping accepted for the server
|-
| min-fps|| || Minimum FPS required for the server
|-
| max-packet-loss|| || Maximum Packet loss accepted in the server
|-
| min-game-version|| || Accepted Game version for the server (Example: 1.41)
|-
|}

== Sample file ==

This is an example file of '''conf.json''':

<syntaxhighlight lang="javascript">
{
{
"announce" : false,
"bind" : "127.0.0.1",
"gamemode" : "freeroam",
"name" : "RAGE:MP Unofficial server",
"maxplayers" : 100,
"port": 22005,
"streamdistance" : 500.0
}
}
</syntaxhighlight>
[[Category:Reference]]

PlayerEnterVehicle

2017-12-18T21:51:51Z

TempletonPeck:

This event is triggered when a player is in the car.

==Parameters==
* '''player''' - player, which sits down.
* '''vehicle''' - vehicle in which the player sits.
* '''seat''' - the place where he sits down.

==Example==
This example outputs chat message, when player is in the car.
<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" style="width: 98%; background-color: #E4F1FE;">
function playerEnterVehicleHandler(player, vehicle, seat) {
const playerName = player.name;
const vehicleID = vehicle.id;

mp.players.broadcast(`${playerName} got into the car with ID: ${vehicleID}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>
</div>

==See also==
{{Player_events}}

PlayerLeftVehicle

2017-12-18T21:50:47Z

TempletonPeck:

This event is triggered when a player went out from a vehicle.

==Parameters==
* '''player''' - player, which left the vehicle
* '''vehicle''' - vehicle, which was left by the player.

==Example==
This example outputs a console chat message, when player went out from vehicle.
<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">
function playerExitVehicleHandler(player, vehicle) {
console.log(`${player.name} when out from vehicle with ID: ${vehicle.id}`);
}

mp.events.add("playerExitVehicle", playerExitVehicleHandler);
</syntaxhighlight>
</div>

==See also==
{{Player_events}}

PlayerExitVehicle

2017-12-18T21:47:55Z

TempletonPeck: TempletonPeck moved page PlayerExitVehicle to PlayerStartExitVehicle

#REDIRECT [[PlayerStartExitVehicle]]

PlayerStartExitVehicle

2017-12-18T21:47:55Z

TempletonPeck: TempletonPeck moved page PlayerExitVehicle to PlayerStartExitVehicle

==Parameters==
* '''player''' - player, which goes out.

==Example==
This example outputs chat message, when player starts exit the car.
<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" style="width: 98%; background-color: #E4F1FE;">
function playerStartExitVehicleHandler(player) {
const playerName = player.name;
const vehicleID = vehicle.id;

mp.players.broadcast(`${playerName} started to exit the car with ID: ${vehicleID}`);
}

mp.events.add("playerStartExitVehicle", playerStartExitVehicleHandler);
</syntaxhighlight>
</div>

==See also==
{{Player_events}}

PlayerStartExitVehicle

2017-12-18T21:46:59Z

TempletonPeck:

PlayerEnterVehicle

2017-12-18T21:46:33Z

TempletonPeck:

This event is triggered when a player is in the car.

==Parameters==
* '''player''' - player, which sits down.
* '''vehicle''' - vehicle in which the player sits.
* '''seat''' - the place where he sits down.

==Example==
This example outputs chat message, when player is in the car.
<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" style="width: 98%; background-color: #E4F1FE;">
function playerEnterVehicleHandler(player, vehicle, seat) {
const playerName = player.name;
const vehicleID = vehicle.id;

mp.players.broadcast(`${playerName} got into the car with ID: ${vehicleID}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>
</div>

==See also==
{{Player_events}}

Storage.flush()

2017-12-02T17:27:23Z

TempletonPeck: /* Example */

Flushes [[storage.data]]. It isn't neccessary to flush it after every change since it will be flushed on disconnect, but recommended.
==Syntax==
<syntaxhighlight lang="javascript">storage.flush();</syntaxhighlight>
==Example==
<syntaxhighlight lang="javascript">
mp.storage.data.auth = { token: "abcd" };
mp.storage.flush();
</syntaxhighlight>

==See also==
[[Category:Clientside API]]

Key::bind

2017-11-30T17:46:20Z

TempletonPeck: Replace integer keycodes with hexadecimal keycodes

This function binds the key .

==Parameters==
* '''keycode''' - code of key (Hexadecimal).
* '''keyhold''' - call function as long as key is held pressed? (Bool)
* '''handler''' - function-handler.

[https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 Keycodes can be found here]

==Example==
This example calling server event.
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<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>
</div>

==See also==
{{KeyBinding_function_c}}