RAGE Multiplayer Wiki - User contributions [en]

Server settings

2018-11-04T21:02:47Z

DeepNeeL: /* 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.
|-
| 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.
|-
| 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.
|-
| language|| en|| Server's language
|-
| 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
|-
| csharp || false|| 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
|}

== 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",
"maxplayers": 100,
"port": 22005,
"streamdistance": 500.0
}
}
</syntaxhighlight>
[[Category:Reference]]

Player::setProp

2018-09-29T00:52:32Z

DeepNeeL:

This function set prop for player.
== Syntax ==
<syntaxhighlight lang="javascript">
player.setProp(Number propID, Number drawable, Number texture)
</syntaxhighlight>
Props:
* 0 - Helmets, hats, earphones, masks
* 1 - Glasses
* 2 - Ear accessories
* 6 - Watches
* 7 - bracelets

Check https://wiki.gt-mp.net/index.php?title=Character_Components for a gallery of possible props

== Example ==
This example changes props.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, command) => {
let arr = command.split(' ');
if (arr[0] == 'setprop') {
if (arr.length < 4 || !parseInt(arr[1]) || !parseInt(arr[2]) || !parseInt(arr[3])) {
return player.outputChatBox('Use syntax: /setprop [prop_id] [drawable_id] [texture_id]');
} else {
player.setProp(parseInt(arr[1]), parseInt(arr[2]), parseInt(arr[3]));
}
}
});
</syntaxhighlight>

==See Also==
{{Player_block}}

Player::setProp

2018-09-29T00:51:53Z

DeepNeeL:

This function set prop for player.
== Syntax ==
<syntaxhighlight lang="javascript">
player.setProp(Number propID, Number drawable, Number texture)
</syntaxhighlight>
Props:
* 0 - Helmets, hats, earphones, masks
* 1 - Glasses
* 2 - Ear accessories
* 6 - Watches (male watches : https://wiki.gt-mp.net/index.php?title=Watches_Male female watches : https://wiki.gt-mp.net/index.php?title=Watches_Female)
* 7 - bracelets

== Example ==
This example changes props.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, command) => {
let arr = command.split(' ');
if (arr[0] == 'setprop') {
if (arr.length < 4 || !parseInt(arr[1]) || !parseInt(arr[2]) || !parseInt(arr[3])) {
return player.outputChatBox('Use syntax: /setprop [prop_id] [drawable_id] [texture_id]');
} else {
player.setProp(parseInt(arr[1]), parseInt(arr[2]), parseInt(arr[3]));
}
}
});
</syntaxhighlight>

==See Also==
{{Player_block}}

Player::setProp

2018-09-29T00:50:01Z

DeepNeeL:

This function set prop for player.
== Syntax ==
<syntaxhighlight lang="javascript">
player.setProp(Number propID, Number drawable, Number texture)
</syntaxhighlight>
Props:
* 0 - Helmets, hats, earphones, masks
* 1 - Glasses
* 2 - Ear accessories
* 6 - Watches
* 7 - bracelets

== Example ==
This example changes props.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, command) => {
let arr = command.split(' ');
if (arr[0] == 'setprop') {
if (arr.length < 4 || !parseInt(arr[1]) || !parseInt(arr[2]) || !parseInt(arr[3])) {
return player.outputChatBox('Use syntax: /setprop [prop_id] [drawable_id] [texture_id]');
} else {
player.setProp(parseInt(arr[1]), parseInt(arr[2]), parseInt(arr[3]));
}
}
});
</syntaxhighlight>

==See Also==
{{Player_block}}

Player::setClothes

2018-09-29T00:49:18Z

DeepNeeL:

This function set clothing for player.

'''palette''' = 2

'''Looks like this function can't handle drawable over 255 ! If you need, I suggest you to use player.data & entityDataChange + entityStreamIn events so you can set it client-side with setComponentVariation'''

== Syntax ==
<syntaxhighlight lang="javascript">
player.setClothes(Number componentNumber, Number drawable, Number texture, Number palette)
</syntaxhighlight>
List of components:
* 0 - Head
* 1 - Beard
* 2 - Hair
* 3 - Torso
* 4 - Legs
* 5 - Hands
* 6 - Foot
* 7 - Eyes
* 8 - Accessories like parachute, scuba tank
* 9 - Accessories like bags, mask, scuba mask
* 10- Decals and mask
* 11 - Auxiliary parts for torso

== Example ==
This example changes clothes.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, command) => {
let arr = command.split(' ');
if (arr[0] == 'setclothes') {
if (arr.length < 5 || parseInt(arr[1]) === undefined || parseInt(arr[2]) === undefined || parseInt(arr[3]) === undefined || parseInt(arr[4]) === undefined) {
return player.outputChatBox('Use syntax: /setclothes [component_id] [drawable_id] [texture_id] [palette_id]');
} else {
player.setClothes(parseInt(arr[1]), parseInt(arr[2]), parseInt(arr[3]), parseInt(arr[4]));
}
}
});
</syntaxhighlight>

==See Also==
{{Player_block}}

[[Category:Clothes]]

Player::setProp

2018-09-29T00:47:28Z

DeepNeeL: /* Syntax */

This function set prop for player.
== Syntax ==
<syntaxhighlight lang="javascript">
player.setProp(Number propID, Number drawable, Number texture)
</syntaxhighlight>
Props:
* 0 - Helmets, hats, earphones, masks
* 1 - Glasses
* 2 - Ear accessories
* 6 - Watches

== Example ==
This example changes props.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, command) => {
let arr = command.split(' ');
if (arr[0] == 'setprop') {
if (arr.length < 4 || !parseInt(arr[1]) || !parseInt(arr[2]) || !parseInt(arr[3])) {
return player.outputChatBox('Use syntax: /setprop [prop_id] [drawable_id] [texture_id]');
} else {
player.setProp(parseInt(arr[1]), parseInt(arr[2]), parseInt(arr[3]));
}
}
});
</syntaxhighlight>

==See Also==
{{Player_block}}

Entity::attachTo

2018-09-25T22:22:50Z

DeepNeeL:

Attaches entity1 to bone (boneIndex) of entity2. boneIndex - this is different to boneID, use GET_Player_BONE_INDEX to get the index from the ID. use the index for attaching to specific bones. entity1 will be attached to entity2's centre if bone index given doesn't correspond to bone indexes for that entity type. useSoftPinning - if set to false attached entity will not detach when fixed collision - controls collision between the two entities (FALSE disables collision). isPed - pitch doesnt work when false and roll will only work on negative numbers (only peds) vertexIndex - position of vertex fixedRot - if false it ignores entity vector 
==Syntax==
<syntaxhighlight lang="javascript">entity.attachTo(entity2, boneIndex, xPosOffset, yPosOffset, zPosOffset, xRot, yRot, zRot, p9, useSoftPinning, collision, isPed, vertexIndex, fixedRot);</syntaxhighlight>
=== Required Arguments ===
*'''entity2:''' Entity handle ( or object, actually it only accepts handles, so use for example player.handle )
*'''boneIndex:''' int
*'''xPosOffset:''' float
*'''yPosOffset:''' float
*'''zPosOffset:''' float
*'''xRot:''' float
*'''yRot:''' float
*'''zRot:''' float
*'''p9:''' Boolean
*'''useSoftPinning:''' Boolean
*'''collision:''' Boolean
*'''isPed:''' Boolean
*'''vertexIndex:''' int
*'''fixedRot:''' Boolean

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

==Example==
<syntaxhighlight lang="javascript">

mp.events.add('arrestAttach', (cop, criminal) => {
criminal.attachTo(cop.handle, 0, 0, 0, 0, 0, 0, 0, true, false, false, false, 0, false);
});

</syntaxhighlight>

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