RAGE Multiplayer Wiki - User contributions [en]

Streaming::requestIpl

2020-04-01T17:40:02Z

C0kkie:

Requests for the IPL to be loaded into the map

List of IPLs: http://pastebin.com/FyV5mMma or https://wiki.rage.mp/index.php?title=Interiors_and_Locations

==Syntax==
<pre>
mp.game.streaming.requestIpl(iplName);
</pre>

=== Required Arguments ===
*'''iplName:''' String

===Return value===
*'''Undefined'''

==Example==
Loads the FIB interior so it can be accessed.

{{ClientsideCode|
<pre>
mp.game.streaming.requestIpl("FIBlobbyfake");
</pre>
}}

==See also==
{{Streaming_s_function_c}}
[[Category:Clientside API]]

Streaming::requestIpl

2020-04-01T17:38:17Z

C0kkie:

Requests for the IPL to be loaded into the map

List of IPLs:
http://pastebin.com/FyV5mMma
https://wiki.rage.mp/index.php?title=Interiors_and_Locations

==Syntax==
<pre>
mp.game.streaming.requestIpl(iplName);
</pre>

=== Required Arguments ===
*'''iplName:''' String

===Return value===
*'''Undefined'''

==Example==
Loads the FIB interior so it can be accessed.

{{ClientsideCode|
<pre>
mp.game.streaming.requestIpl("FIBlobbyfake");
</pre>
}}

==See also==
{{Streaming_s_function_c}}
[[Category:Clientside API]]

Server settings

2020-03-31T15:32:52Z

C0kkie: /* Settings */

* '''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|| false|| Whether the connection to the server will be encrypted or not.
|-
| 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|| en || Server's language (needs to be a string, example: "language": "en")
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| 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|| 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 || false || boolean true / false, if it's set to true, clientside created wont be synced only if they got created serverside (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. (available with RAGE 1.1+)
|-
| node-commandline-flags || || e.g. "node-commandline-flags": "--inspect" (available with RAGE 1.1+)
|-
| synchronization-extrapolation-multiplier || 0.0 || disables ping "immunity" but makes it a bit smoother (available with RAGE 1.1+)
|}

== 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>
[[Category:Reference]]

Server settings

2020-02-04T18:03:53Z

C0kkie: /* Settings */

* '''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|| false|| Whether the connection to the server will be encrypted or not.
|-
| 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|| en || Server's language (needs to be a string, example: "language": "en")
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| 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|| 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 || false || boolean true / false, if it's set to true, clientside created wont be synced only if they got created serverside (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. (available with RAGE 1.1+)
|-
| resources-compression-level || 1 || Use 0 for local server, or a higher value for bandwidth optimisation. (available with RAGE 1.1+)
|-
| node-commandline-flags || || e.g. "node-commandline-flags": "--inspect" (available with RAGE 1.1+)
|}

== 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>
[[Category:Reference]]

Server settings

2020-02-04T18:01:24Z

C0kkie: /* Settings */

* '''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|| false|| Whether the connection to the server will be encrypted or not.
|-
| 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|| en || Server's language (needs to be a string, example: "language": "en")
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| 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|| 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 || false || boolean true / false, if it's set to true, clientside created wont be synced only if they got created serverside (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+)
|}

== 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>
[[Category:Reference]]

Server settings

2020-02-04T18:00:54Z

C0kkie: /* Settings */

* '''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|| false|| Whether the connection to the server will be encrypted or not.
|-
| 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|| en || Server's language (needs to be a string, example: "language": "en")
|-
| sync-rate|| 40|| This number indicates how many times per second the server has to synchronize its entities
|-
| 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|| 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 || false || boolean true / false, if it's set to true, clientside created wont be synced only if they got created serverside (available with 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 1.1+)
|}

== 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>
[[Category:Reference]]

Player::playFacialAnim

2018-12-14T19:21:02Z

C0kkie: /* Syntax */

==Syntax==
<syntaxhighlight lang="javascript">player.PlayFacialAnim(animName, animDict);</syntaxhighlight>
=== Required Arguments ===
*'''animName:''' String
*'''animDict:''' String
===Return value===
*'''Undefined'''

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

Player::playFacialAnim

2018-12-14T18:06:44Z

C0kkie:

==Syntax==
<syntaxhighlight lang="javascript">player.PlayFacialAnim(animName, animDict);</syntaxhighlight>
=== Required Arguments ===
*'''animName:''' String
*'''animDict:''' String
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]