RAGE Multiplayer Wiki - User contributions [en]

Graphics::getScreenResolution

2019-11-12T19:35:45Z

Meta: Improved the return value formatting

int screenresx,screenresy; GET_SCREEN_RESOLUTION(&screenresx,&screenresy);
==Syntax==
<syntaxhighlight lang="javascript">mp.game.graphics.getScreenResolution(x, y);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' int
*'''y:''' int
===Return value===
*'''object:''' x, y
{{info|The returned object seems to be static.
<syntaxhighlight lang="json">
{ "x": 1280, "y": 720 }
</syntaxhighlight>}}
==See also==
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Graphics::getScreenResolution

2019-11-12T19:27:28Z

Meta: Some formatting for the return value note

int screenresx,screenresy; GET_SCREEN_RESOLUTION(&screenresx,&screenresy);
==Syntax==
<syntaxhighlight lang="javascript">mp.game.graphics.getScreenResolution(x, y);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' int
*'''y:''' int
===Return value===
*'''object:''' x, y
{{info|The returned object seems to be static.}}
<syntaxhighlight lang="json">
{
"x": 1280,
"y": 720
}
</syntaxhighlight>
==See also==
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Graphics::getScreenResolution

2019-11-12T19:23:33Z

Meta: Added a note for the functions' possibly static return values

int screenresx,screenresy; GET_SCREEN_RESOLUTION(&screenresx,&screenresy);
==Syntax==
<syntaxhighlight lang="javascript">mp.game.graphics.getScreenResolution(x, y);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' int
*'''y:''' int
===Return value===
*'''object:''' x, y
The returned object seems to be static.
<syntaxhighlight lang="json">
{
"x": 1280,
"y": 720
}
</syntaxhighlight>
==See also==
{{Graphics_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::isHeliPartBroken

2019-02-17T15:33:28Z

Meta:

Returns if any of the heli parts selected as boolean arguments is broken (they pretty much work like bit flags).
{{ClientsideJsFunction}}
{{JSContainer|
==Syntax==
<syntaxhighlight lang="javascript">vehicle.isHeliPartBroken(mainRotor, tailRotor, tail);</syntaxhighlight>
=== Required Arguments ===
*'''mainRotor:''' Boolean
*'''tailRotor:''' Boolean
*'''tail:''' Boolean
===Return value===
*'''Boolean''' - if anything matching your selection is broken.

'''Note:''' If the tail is broken, the tail rotor is broken too!
==Example==
<syntaxhighlight lang="javascript">
const veh = mp.players.local.vehicle

if(veh.isHeliPartBroken(true, false, false)) { /* main rotor is broken */}
if(veh.isHeliPartBroken(false, true, false)) { /* tail rotor is broken */}
if(veh.isHeliPartBroken(false, false, true)) { /* the whole tail is ripped off */}

if(veh.isHeliPartBroken(true, true, false)) { /* any of the rotors are broken */}
if(veh.isHeliPartBroken(true, false, true)) { /* the main rotor or the whole tail is broken */}
if(veh.isHeliPartBroken(false, true, true)) { /* something related to the tail is broken */}

if(veh.isHeliPartBroken(true, true, true)) { /* something is broken, you just don't know what. */ }
</syntaxhighlight>
}}
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::isHeliPartBroken

2019-02-17T15:31:14Z

Meta:

Returns if any of the heli parts selected as boolean arguments is broken (they pretty much work like bit flags).
{{ClientsideJsFunction}}
{{JSContainer|
==Syntax==
<syntaxhighlight lang="javascript">vehicle.isHeliPartBroken(mainRotor, tailRotor, tail);</syntaxhighlight>
=== Required Arguments ===
*'''mainRotor:''' Boolean
*'''tailRotor:''' Boolean
*'''tail:''' Boolean
===Return value===
*'''Boolean''' - if anything matching your selection is broken.

'''Note:''' If the tail is broken, the tail rotor is broken too!
==Example==
<syntaxhighlight lang="javascript">
const veh = mp.players.local.vehicle

if(veh.isHeliPartBroken(true, false, false)) {
// main rotor is broken
}
if(veh.isHeliPartBroken(false, true, false)) {
// tail rotor is broken
}
if(veh.isHeliPartBroken(false, false, true)) {
// the whole tail is ripped off
}

if(veh.isHeliPartBroken(true, true, false)) {
// any of the rotors are broken
}
if(veh.isHeliPartBroken(true, false, true)) {
// the main rotor or the whole tail is broken
}
if(veh.isHeliPartBroken(false, true, true)) {
// something related to the tail is broken
}

if(veh.isHeliPartBroken(true, true, true)) {
// something is broken, you just don't know what.
}
</syntaxhighlight>
}}
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::isHeliPartBroken

2019-02-17T11:57:00Z

Meta: Added knowledge

Returns if any of the heli parts selected as boolean arguments is broken (they pretty much work like bit flags).
{{ClientsideJsFunction}}
{{JSContainer|
==Syntax==
<syntaxhighlight lang="javascript">vehicle.isHeliPartBroken(mainRotor, tailRotor, tail);</syntaxhighlight>
=== Required Arguments ===
*'''mainRotor:''' Boolean
*'''tailRotor:''' Boolean
*'''tail:''' Boolean
===Return value===
*'''Boolean''' - if anything matching your selection is broken.

'''Note:''' If the tail is broken, the tail rotor is broken too!
==Example==
<syntaxhighlight lang="javascript">
const veh = mp.players.local.vehicle

if(veh.isHeliPartBroken(true, false, false)) {
// main rotor is broken
}
if(veh.isHeliPartBroken(false, true, false)) {
// tail rotor is broken
}
if(veh.isHeliPartBroken(false, false, true)) {
// the whole tail is ripped off
}

if(veh.isHeliPartBroken(true, true, false)) {
// any of the rotors are broken
}
if(veh.isHeliPartBroken(true, false, true)) {
// the main rotor or something related to the tail is broken
}
if(veh.isHeliPartBroken(false, true, true)) {
// something related to the tail is broken
}

if(veh.isHeliPartBroken(true, true, true)) {
// something is broken, you just don't know what.
}
</syntaxhighlight>
}}
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Client-side functions

2018-01-04T22:06:10Z

Meta: /* Script */ fixed marker

Attention: work is still in progress. There still could be major changes in design of API.
==Game==
===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
*Functions:
**[[Globals::joaat|mp.game.joaat]]
*Properies:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Streaming===
{{Streaming_functions_c}}

===System===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

==RAGEMP==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Cursor===
*Properties:
**cursor.visible
**cursor.position

===Entity===
{{Entity_functions_c}}

===Entity pool===
*[[Pool::atHandle]]
*[[Pool::atRemoteId]]
{{EntityPool_definition}}

===Event===
{{Event_functions_c}}

===Global===
{{Global_properties_c}}

===Gui===
{{Gui_definition_c}}

===Keys===
{{Keys_functions_c}}

===Nametags===
*Functions:
**mp.nametags.update
**[[nametags.set|mp.nametags.set]]
*Properties:
**mp.nametags.enabled

===Object===
{{Object_definition_c}}

===Peds===
*[[Peds::new|mp.peds.new]]

===Player===
{{Player_definition_c}}

===Raycasting===
**[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
**[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Storage===
*Functions:
**[[storage.flush()|mp.storage.flush]]
*Properties:
**mp.storage.data

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

Player::simulatePlayerInputGait

2018-01-02T21:38:07Z

Meta: added commas between the arguments in the syntax box

This is to make the player walk without accepting input from INPUT. gaitType is in increments of 100s. 2000, 500, 300, 200, etc. p4 is always 1 and p5 is always 0. C# Example : Function.Call(Hash.SIMULATE_PLAYER_INPUT_GAIT, Game.Player, 1.0f, 100, 1.0f, 1, 0); //Player will go forward for 100ms
==Syntax==
<syntaxhighlight lang="javascript">mp.game.player.simulatePlayerInputGait(amount, gaitType, speed, p4, p5);</syntaxhighlight>
=== Required Arguments ===
*'''amount:''' float
*'''gaitType:''' int
*'''speed:''' float
*'''p4:''' Boolean
*'''p5:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Server settings

2017-12-28T11:37:22Z

Meta: Added info about the HTTP server for client packages

* '''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.
|-
| streamdistance || 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|| ...
|-
| 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]]

Player::setIntoVehicle

2017-12-27T14:28:50Z

Meta:

Ped: The ped to warp. vehicle: The vehicle to warp the ped into. Seat_Index: [-1 is driver seat, -2 first free passenger seat]

More info of Seat Index DriverSeat = 0 Passenger = 1 Left Rear = 2 RightRear = 3

(note this is for normal vehicles with 4 seats)
==Syntax==
<syntaxhighlight lang="javascript">player.setIntoVehicle(vehicle, seatIndex);</syntaxhighlight>
=== Required Arguments ===
*'''vehicle:''' Vehicle handle or object
*'''seatIndex:''' int
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]