RAGE Multiplayer Wiki - User contributions [en]

Object::getClosestObjectOfType

2021-07-01T15:25:41Z

JockeyBird: /* Example */ should work now, apparently, forEach messes with return...

Has 8 params in the latest patches. isMission - if true doesn't return mission objects
==Syntax==
<syntaxhighlight lang="javascript">mp.game.object.getClosestObjectOfType(x, y, z, radius, modelHash, isMission, p6, p7);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''radius:''' float
*'''modelHash:''' Model hash or name
*'''isMission:''' Boolean
*'''p6:''' Boolean
*'''p7:''' Boolean
===Return value===
*'''Object handle'''
==Example==
I use it for interaction with objects of type. E.g. atms, vending machines, bins, etc...
<syntaxhighlight lang="javascript">
const player = mp.players.local;
// atms
// There are four different types of atms, so I will create this array with hashes of them
atms = [
mp.game.joaat("prop_atm_01"),
mp.game.joaat("prop_atm_02"),
mp.game.joaat("prop_atm_03"),
mp.game.joaat("prop_fleeca_atm")
];
// I need a range. I make this variable to ease any configuration
var atmRange = 1.5;
nextToAtm = function(player) {
// We want to iterate over every type of atm
for (let i = 0; i < atms.length; i++) {
const atmHash = atms[i];
// any atm withing range our check object, or nothing
var check = mp.game.object.getClosestObjectOfType(player.position.x, player.position.y, player.position.z, atmRange, atmHash, false, true, true);
// object -> true, nothing -> false
if (check) {
return true;
}
});
// If none of the types of atms is in reach, we'll return false
return false;
}
</syntaxhighlight>

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

Object::getClosestObjectOfType

2021-07-01T03:28:36Z

JockeyBird: Example: forgot to define player

Has 8 params in the latest patches. isMission - if true doesn't return mission objects
==Syntax==
<syntaxhighlight lang="javascript">mp.game.object.getClosestObjectOfType(x, y, z, radius, modelHash, isMission, p6, p7);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''radius:''' float
*'''modelHash:''' Model hash or name
*'''isMission:''' Boolean
*'''p6:''' Boolean
*'''p7:''' Boolean
===Return value===
*'''Object handle'''
==Example==
I use it for interaction with objects of type. E.g. atms, vending machines, bins, etc...
<syntaxhighlight lang="javascript">
const player = mp.players.local;
// atms
// There are four different types of atms, so I will create this array with hashes of them
atms = [
mp.game.joaat("prop_atm_01"),
mp.game.joaat("prop_atm_02"),
mp.game.joaat("prop_atm_03"),
mp.game.joaat("prop_fleeca_atm")
];
// I need a range. I make this variable to ease any configuration
var atmRange = 1.5;
nextToAtm = function(player) {
// We want to iterate over every type of atm
atms.forEach(atmHash => {
// any atm withing range our check object, or nothing
var check = mp.game.object.getClosestObjectOfType(player.position.x, player.position.y, player.position.z, atmRange, atmHash, false, true, true);
// object -> true, nothing -> false
if (check) {
object = check;
return true;
}
});
// If none of the types of atms is in reach, we'll return false
return false;
}
</syntaxhighlight>

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

Object::getClosestObjectOfType

2021-07-01T03:06:48Z

JockeyBird: Edited my Example due to some formating mistakes and some wrong code

Has 8 params in the latest patches. isMission - if true doesn't return mission objects
==Syntax==
<syntaxhighlight lang="javascript">mp.game.object.getClosestObjectOfType(x, y, z, radius, modelHash, isMission, p6, p7);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''radius:''' float
*'''modelHash:''' Model hash or name
*'''isMission:''' Boolean
*'''p6:''' Boolean
*'''p7:''' Boolean
===Return value===
*'''Object handle'''
==Example==
I use it for interaction with objects of type. E.g. atms, vending machines, bins, etc...
<syntaxhighlight lang="javascript">
// atms
// There are four different types of atms, so I will create this array with hashes of them
atms = [
mp.game.joaat("prop_atm_01"),
mp.game.joaat("prop_atm_02"),
mp.game.joaat("prop_atm_03"),
mp.game.joaat("prop_fleeca_atm")
];
// I need a range. I make this variable to ease any configuration
var atmRange = 1.5;
nextToAtm = function(player) {
// We want to iterate over every type of atm
atms.forEach(atmHash => {
// any atm withing range our check object, or nothing
var check = mp.game.object.getClosestObjectOfType(player.position.x, player.position.y, player.position.z, atmRange, atmHash, false, true, true);
// object -> true, nothing -> false
if (check) {
object = check;
return true;
}
});
// If none of the types of atms is in reach, we'll return false
return false;
}
</syntaxhighlight>

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

Object::getClosestObjectOfType

2021-07-01T02:59:12Z

JockeyBird: Example added

Has 8 params in the latest patches. isMission - if true doesn't return mission objects
==Syntax==
<syntaxhighlight lang="javascript">mp.game.object.getClosestObjectOfType(x, y, z, radius, modelHash, isMission, p6, p7);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''radius:''' float
*'''modelHash:''' Model hash or name
*'''isMission:''' Boolean
*'''p6:''' Boolean
*'''p7:''' Boolean
===Return value===
*'''Object handle'''
==Example==
I use it for interaction with objects of type. E.g. atms, vending machines, bins, etc...
<syntaxhighlight lang="javascript">
// atms
// There are four different types of atms, so I will create this array with hashes of them
nextToAtm = function(player) {
atms = [
mp.game.joaat("prop_atm_01"),
mp.game.joaat("prop_atm_02"),
mp.game.joaat("prop_atm_03"),
mp.game.joaat("prop_fleeca_atm")
];
// I need a range. I make this variable to ease any configuration
var atmRange = 1.5;
// We want to iterate over every type of atm
atms.forEach(atmHash => {
// any atm withing range our check object, or nothing
var check = mp.game.object.getClosestObjectOfType(player.position.x, player.position.y, player.position.z, atmRange, atmHash, false, true, true);
// object -> true, nothing -> false
if (check) {
object = check;
return true;
}
});
// If none of the types of atms is in reach, we'll return false
return false;
}
</syntaxhighlight>

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

Getting Started with Server

2021-06-29T03:10:48Z

JockeyBird: Added a invalid note to the link

== Introduction ==

*[[Ru:Getting Started with Server]]

This brief tutorial will show you how to run your server on both Windows and Linux distributions.

By default, the server makes use of port 22005 UDP for server access and the port after (here 22006) for the HTTP server hosting the client packages for the clients to download from. 
So make sure to have done the ports forwarding on your router process and have also unblocked the ports on your firewall before running the server.

=Bridge=
The following tutorial is found on [https://wiki.gtanet.work/index.php?title=Setting_up_the_Bridge_on_Linux/Windows Setting up the Bridge on Linux/Windows].

=Windows=
==Prerequisite==
For a hassle-free installation and operation, it is recommended to have the latest VC Redist.

[https://aka.ms/vs/15/release/VC_redist.x64.exe Microsoft Visual C++ Redistributable 2017]

==Setting up the server==
1. Download the latest [https://cdn.rage.mp/client/updater.exe updater.exe]. (invalid)
: '''Note:''' Server files are also already included with installation of RAGE-MP Client for Windows.

2. Run the downloaded '''updater.exe'''.

3. Launch '''server-files/server.exe''' and you should be able to connect to it (default local host IP: '''127.0.0.1:22005''').
: Read more about [https://wiki.rage.mp/index.php?title=Server_settings Server Settings].

==Next step==
[[Getting Started with Development]]

=Linux=
==Prerequisite==
It's recommended to use Debian or Ubuntu to set up a server if you're new to Linux.
*Debian 10 or above [https://distrowatch.com/table.php?distribution=debian See more]
*Ubuntu 18.10 or above [https://distrowatch.com/table.php?distribution=ubuntu See more]
*An OS that supports glibc v2.28

===Ubuntu===
<syntaxhighlight lang="bash">
sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
sudo apt update && sudo apt install libstdc++6
</syntaxhighlight>

===Debian===
<syntaxhighlight lang="bash">
echo 'deb http://httpredir.debian.org/debian testing main contrib non-free' > /etc/apt/sources.list
apt update && apt install -y -t testing libstdc++6
</syntaxhighlight>

==Setting up server==
This bash snippet should automate the server installation.
<syntaxhighlight lang="bash">
# Downloading server
wget https://cdn.rage.mp/updater/prerelease/server-files/linux_x64.tar.gz

# Extract the server files
tar -xzf linux_x64.tar.gz

# Accessing the directory
cd ragemp-srv

# Set executable permission
chmod +x ragemp-server

# Run the server
./ragemp-server
</syntaxhighlight>

==Launching the server as a daemon (systemd)==
If you want to launch the server as a daemon on the latest version of Ubuntu/Debian/CentOS, you need to follow these steps:

1. We recommend move your server to /opt
e.g '''mv ./ragemp-srv /opt/'''

2. Create the systemd unit (e.g /etc/systemd/system/rageserv.service) and enter this config:

<syntaxhighlight lang="ini">
[Unit]
Description=RAGE-MP Dedicated server
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=1
; not safe, change root to another user
User=root
WorkingDirectory=/opt/ragemp-srv
ExecStart=/opt/ragemp-srv/ragemp-server

[Install]
WantedBy=multi-user.target
</syntaxhighlight>

'''Important: If you have not moved the directory, you need to edit WorkingDirectory and ExecStart with new absolute paths.'''

3. After saving the new unit we recommend you to update your systemd unit's list.

4. Finally! Now you can enable and run the unit via these commands:
# systemctl enable rageserv
# systemctl start rageserv

If you want to watch status of your server you need enter:
<syntaxhighlight lang="bash">
systemctl status rageserv
</syntaxhighlight>

If you want to restart your server you need to enter:
<syntaxhighlight lang="bash">
systemctl restart rageserv
</syntaxhighlight>

More commands and other details can be found [https://www.freedesktop.org/software/systemd/man/systemctl.html#Unit%20File%20Commands here.]

==Installing screen (Optional)==
For running the server in the background, we recommend using screen, mainly for its ease of use.

===Debian based (Ubuntu & derivatives)===
<syntaxhighlight lang="bash">
sudo apt-get install screen
</syntaxhighlight>

===CentOS 6.x/7.x===
<syntaxhighlight lang="bash">
yum install screen
</syntaxhighlight>

===Starting the server===
<syntaxhighlight lang="bash">
screen -dmS GTASERVER -L bash -c 'cd ~/srv && ./server' &
</syntaxhighlight>
Parameter explanation:
* <syntaxhighlight lang="bash" inline>screen -dmS</syntaxhighlight> starts a separate shell without directly opening an interface towards it (detached mode). The <tt>S</tt> param defines a session name for the newly created session (in this case <code>GTASERVER</code>), so that it is easier to manage in the future.
* <syntaxhighlight lang="bash" inline>screen -L</syntaxhighlight> basically logs whatever error that is shown by the server through the separate shell into a file for easier reference in the future.
'''!IMPORTANT!'''
* Log output will be saved as <code>screenlog.''_number_''</code> in the server directory.
* <code>&</code> '''IS IMPORTANT''' IF YOU WANT TO TERMINATE THE PROCESS GRACEFULLY.

===Stopping the server===
There are usually two ways to stop the server; One that we call a '''graceful''' shutdown that sends the server a signal for termination and the other, well, a '''crash''' since it does not allow the code to run through the termination process correctly.

'''RECOMMENDED:'''
<syntaxhighlight lang="bash">
kill $(ps h --ppid $(screen -ls | grep GTASERVER | cut -d. -f1) -o pid)
</syntaxhighlight>

'''NOT RECOMMENDED:''' It does not shut down the server gracefully
<syntaxhighlight lang="bash">
screen -S GTASERVER -X quit
</syntaxhighlight>

=Troubleshooting=
==Linux==
<syntaxhighlight lang="bash">
./server: /usr/lib/x86_64-linux-gnu/libstdc++.so.6: version `GLIBCXX_3.4.22' not found (required by ./server)
</syntaxhighlight>

Make sure GCC/G++ 6 or newer is installed, follow the [[#Prerequisite_2|Prerequisite]].

= See also =
* [[Server settings]]
{{ScriptingTutorials}}

[[Category:Tutorials]]