RAGE Multiplayer Wiki - User contributions [en]

Server settings

2024-09-15T16:09:12Z

Pietrodc0:

* '''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. [[gamemodes|List of valid gamemodes]]
|-
| encryption'''(deprecated)'''|| true || Setting is deprecated because it is always enabled and can not be disabled.
|-
| 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. Use [] for tags. Eg. "Beast [Serious Roleplay]"
|-
| 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. 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|| Allows (false) or disallows (true) multiple players to connect from the same IP address
|-
| limit-time-of-connections-per-ip|| 0|| Maximum time a player can try to reconnect before getting timeout
|-
| url|| || Website URL. Must be a valid URL. Truncated to 20 characters in [https://rage.mp/masterlist RAGE:MP Master List Web] (shows fine in RAGE:MP client).
|-
| language|| us || Server's language (needs to be a string, example: "language": "us" will display the United States flag on your server's name)
|-
| sync-rate|| 40|| This number indicates the interval, in milliseconds, that the server has to synchronize its entities. 40 = 40ms
|-
| resource-scan-thread-limit|| || Indicates the maximum number of threads used for resource scanning
|-
| 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
|-
| allow-cef-debugging || || Whether the client can (true) or not (false) debug the server's CEF pages
|-
| enable-nodejs || true || Enables NodeJS serverside
|-
| csharp || disabled|| If your server will be using the C# bridge plugin set it to true, else don't add this line
|-
| enable-http-security'''(note¹)'''|| false|| When set to true, enables an extra security layer to avoid the server being flooded by fake HTTP requests
|
|-
| voice-chat || || boolean true / false
|
|-
| allow-voice-chat-input || || (only available via registry at the moment); default value: 1
|
|-
| voice-chat-sample-rate || || allowed values are 8000, 16000, 24000, 48000
|-
| fastdl-host || || String URL, this parameter specifies the external URL from which clients will be able to download needed clientside packages. Otherwise they will download them directly from the server.
|-
| server-side-weapons-only-mode || true || boolean true / false, if it's set to true, only weapons that are given from server side will be synced (available with RAGE 1.1+)
|-
| api-threading-debugging || false || If set to true, it'll report every single usage of the API out of proper thread. Use it only for debugging since it adds some CPU overhead. (available with RAGE 1.1+)
|-
| fqdn || || string, e.g. "fqdn": "game-srv.rage.mp". Thanks to this option your players won't notice any server IP change, including the re-utilisation of downloaded packages.
|-
| resources-compression-level || 1 || Use 0 for local server, or a higher value for bandwidth optimisation. -9 for fast compression (available with RAGE 1.1+)
|-
| node-commandline-flags || || e.g. "node-commandline-flags": "--inspect" (available with RAGE 1.1+)
|-
| synchronization-extrapolation-multiplier || 0.0 || enables vehicle synchronization prediction disabling possible latency offset (available with RAGE 1.1+, enabled by default with 1.0 value in 0.3.7)
|-
| http-threads || 50 || Specifies how many concurrent connections will be handled at the same time, the rest will be queued (Increasing this number will increase bandwidth usage)
|-
| trigger-compression-logging || false || Log compression rates of all outgoing client event triggers with the dictionary the server has been initialized with (available with RAGE 1.1+)
|-
| trigger-compression-training || false || Dictionary training, takes data from all of your triggers and flushes it to the file specified at "trigger-compression-dictionary" at every 20th trigger. TIP: You can train it without joining using "mp.players.call" (available with RAGE 1.1+)
|-
| trigger-compression-dictionary || || File to load/save compression dictionary (available with RAGE 1.1+)
|
|-
| create-fastdl-snapshot || false || Generates client packages files to a folder to be downloadable and used with FastDL
|-
| disable-client-packages-ram-cache || false || Doesn't cache resources in memory (for only un-encrypted files with DISABLE_ENCRYPTION_LIST file) and instead streams it from storage
|-
| client-packages-shared-folder || || Enables you to use the same client resources across different servers (i guess) (FQDN must be a subdomain of shared folder name, e.g. foo.domain.com, bar.domain.com => domain.com)
|}

== Sample file ==

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

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

== Notes ==
note¹: at least with Rage 1.1, setting this parameter to true causes missing download of resources from the launcher. The client needs to connect a second time to see the resources downloaded during previous connection. Suggestion is to keep it false.
[[Category:Reference]]

Entity::getVariable

2024-09-12T17:17:21Z

Pietrodc0:

__NOTOC__

Retrieves a server side custom data from the entity.

{{ServersideJsFunction}}

{{JSContainer|
==Syntax==
<pre>
entity.getVariable('variableName');
</pre>

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

==Example==
This example will retrieve the data from the variable 'veh' that is assigned to the player
{{ServersideCode|
<pre>
mp.events.addCommand('setNick', (player, nickname) => {
player.setVariable('oldNick', player.name);
player.name = nickname;
player.setVariable('newNick', nickname);
console.log(`Player[${player.id}] Changed nick from ${player.getVariable('oldNick')} to ${player.name}`);
});
</pre>
}}
}}

== See More ==
{{Entity_functions}}

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

Entity::setVariable

2024-09-12T17:15:26Z

Pietrodc0:

__TOC__

Set custom data to an entity. These variables are visible only server side. 
See [[Entity::setVariables]] to set multiple variables in bulk.
 

{{ServersideJsFunction}}

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

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

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

}}

== See More ==
{{Entity_functions}}

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

Server-side functions

2024-09-12T17:11:27Z

Pietrodc0: add Entity to list

==Global==
{{Global_definition}}

==Blip==
{{Blip_definition}}

==Checkpoint==
{{Checkpoint_definition}}

==Colshape==
{{Colshape_definition}}

==Colshape pool==
{{ColshapePool_definition}}

==Entity pool==
{{EntityPool_definition}}

==Entity==
{{Entity_definition}}

==Event==
{{Event_functions}}

==Label==
{{Label_definition}}

==Marker==
{{Marker_definition}}

==Network==
{{Network_definition}}

==Object==
{{Object_block}}

==Pickup==
{{Pickup_definition}}

==Ped==
{{Ped_definition}}

==Player==
{{Player_definition}}

==Player pool==
{{PlayerPool_definition}}

==Vector3==
{{Vector3_definition}}

==Vehicle==
{{Vehicle_definition}}

==World==
{{World_definition}}

Server-side CSharp events

2024-09-08T17:18:20Z

Pietrodc0: /* Entity */

==Global==
* [[OnUpdate|Update]]
* [[OnChatMessage|ChatMessage]]
* [[FirstChanceException]]
* [[UnhandledException]]

==Resource==
* [[OnResourceStart|ResourceStart]]
* [[OnResourceStop|ResourceStop]]
* [[OnServerResourceStart|ServerResourceStartEx]]
* [[OnServerResourceStop|ServerResourceStopEx]]

==Entity==
(Every server handled object is called an 'entity', which includes Players, Vehicles, Objects and etc..)
* [[OnEntityModelChange|EntityModelChange]]
* [[EntityCreated]]
* [[EntityDestroyed]] ''(deprecated in 1.1)''
* [[EntityDeleted]]

==Player==
* [[OnPlayerIncomingConnection|PlayerIncomingConnection]]
* [[OnPlayerConnected|PlayerConnected]]
* [[OnPlayerDisconnected|PlayerDisconnected]]
* [[OnPlayerDamage|PlayerDamage]]
* [[OnPlayerDeath|PlayerDeath]]
* [[OnPlayerSpawn|PlayerSpawn]]
* [[OnPlayerPickup|PlayerPickup]]
* [[PlayerEnterVehicleAttempt]]
* [[PlayerExitVehicleAttempt]]
* [[OnPlayerEnterVehicle|PlayerEnterVehicle]]
* [[OnPlayerExitVehicle|PlayerExitVehicle]]
* [[OnPlayerWeaponSwitch|PlayerWeaponSwitch]]
* [[OnPlayerDetonateStickies|PlayerDetonateStickies]]

==ColShapes==
* [[OnPlayerEnterColShape|PlayerEnterColShape]]
* [[OnPlayerExitColShape|PlayerExitColShape]]

==Checkpoints==
* [[OnPlayerEnterCheckpoint|PlayerEnterCheckpoint]]
* [[OnPlayerExitCheckpoint|PlayerExitCheckpoint]]

==Vehicle==
* [[OnVehicleDamage|VehicleDamage]]
* [[OnVehicleDeath|VehicleDeath]]
* [[OnVehicleSirenToggle|VehicleSirenToggle]]
* [[OnVehicleHornToggle|VehicleHornToggle]]
* [[OnVehicleDoorBreak|VehicleDoorBreak]]
* [[OnVehicleWindowSmash|VehicleWindowSmash]]
* [[OnVehicleTyreBurst|VehicleTyreBurst]]
* [[OnVehicleTrailerChange|VehicleTrailerChange]]

EntityCreated

2024-09-08T17:15:26Z

Pietrodc0: /* See also */

This event is triggered when an Entity Is Created. From my testing, this event is only accessible on the serverside.

{{ServersideCsJsEvent}}

{{JSContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity API|entity]] that was created

{{Example}}
<pre>
function entityCreatedHandler(entity) {
console.log(`An Entity with the ID of ${entity.id} was created at ${entity.position}`);
}

mp.events.add("entityCreated", entityCreatedHandler);
</pre>
}}

{{CSharpContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity API|entity]] that was created

{{Example}}
The example below logs in server console when an entity is created, showing the entity model, position and remoteId.
<syntaxhighlight lang="csharp">
[ServerEvent(Event.EntityCreated)]
public void OnEntityCreated(GTANetworkAPI.Entity entity)
{
NAPI.Util.ConsoleOutput($"{entity.Model} created at {entity.Position} with serverside id:{entity.Id}");
}
</syntaxhighlight>
}}

{{ClientsideCsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnEntityCreatedDelegate(Entity entity);
</syntaxhighlight>
{{Parameters}}
* '''entity''' - the streamed in entity, expects '''RAGE.Elements.Entity'''

{{Example}}
The example below sends a message to client when an entity is created, showing the entity model, position and remoteId.
<syntaxhighlight lang="csharp">
Events.OnEntityCreated += OnEntityCreated;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnEntityCreated(RAGE.Elements.Entity entity)
{
RAGE.Chat.Output($"{entity.Model} created at {entity.Position} with serverside id:{entity.RemoteId}");
}
</syntaxhighlight>
}}

==See also==
* [[entityDeleted]]
* [[entityDestroyed]]
* [[entityModelChange]]

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

EntityDeleted

2024-09-08T17:15:10Z

Pietrodc0: Created page with "This event is triggered when an Entity Is Deleted. From my testing, this event is only accessible on the serverside. {{ServersideCsJsEvent}} {{JSContainer| {{Parameters}} * '''entity''': {{RageType|Entity}} - the entity that was deleted {{Example}} <pre> function entityDeletedHandler(entity) { console.log(`Entity with handle id ${entity.id} has beenb deleted`); } mp.events.add("entityDeleted", entityDeletedHandler); </pre> }} {{CSharpConta..."

This event is triggered when an Entity Is Deleted. From my testing, this event is only accessible on the serverside.

{{ServersideCsJsEvent}}

{{JSContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity API|entity]] that was deleted

{{Example}}
<pre>
function entityDeletedHandler(entity) {
console.log(`Entity with handle id ${entity.id} has beenb deleted`);
}

mp.events.add("entityDeleted", entityDeletedHandler);
</pre>
}}

{{CSharpContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity API|entity]] that was deleted

{{Example}}
The example below logs in server console when an entity is created, showing the entity model, position and remoteId.
<syntaxhighlight lang="csharp">
[ServerEvent(Event.EntityDeleted)]
public void OnEntityDeleted(GTANetworkAPI.Entity entity)
{
NAPI.Util.ConsoleOutput($"Entity with handle id {entity.Handle} has been deleted");
}
</syntaxhighlight>
}}

==See also==
* [[entityCreated]]
* [[entityDestroyed]]
* [[entityModelChange]]

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

EntityCreated

2024-09-08T17:10:21Z

Pietrodc0: Add server side C# example

This event is triggered when an Entity Is Created. From my testing, this event is only accessible on the serverside.

{{ServersideCsJsEvent}}

{{JSContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity API|entity]] that was created

{{Example}}
<pre>
function entityCreatedHandler(entity) {
console.log(`An Entity with the ID of ${entity.id} was created at ${entity.position}`);
}

mp.events.add("entityCreated", entityCreatedHandler);
</pre>
}}

{{CSharpContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity API|entity]] that was created

{{Example}}
The example below logs in server console when an entity is created, showing the entity model, position and remoteId.
<syntaxhighlight lang="csharp">
[ServerEvent(Event.EntityCreated)]
public void OnEntityCreated(GTANetworkAPI.Entity entity)
{
NAPI.Util.ConsoleOutput($"{entity.Model} created at {entity.Position} with serverside id:{entity.Id}");
}
</syntaxhighlight>
}}

{{ClientsideCsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnEntityCreatedDelegate(Entity entity);
</syntaxhighlight>
{{Parameters}}
* '''entity''' - the streamed in entity, expects '''RAGE.Elements.Entity'''

{{Example}}
The example below sends a message to client when an entity is created, showing the entity model, position and remoteId.
<syntaxhighlight lang="csharp">
Events.OnEntityCreated += OnEntityCreated;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnEntityCreated(RAGE.Elements.Entity entity)
{
RAGE.Chat.Output($"{entity.Model} created at {entity.Position} with serverside id:{entity.RemoteId}");
}
</syntaxhighlight>
}}

==See also==
* [[entityDestroyed]]
* [[entityModelChange]]

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