RAGE Multiplayer Wiki - User contributions [en]

PlayerEnterVehicle

2019-09-03T14:52:44Z

RoboN1X: Undo revision 18041 by Mentanding (talk) -- This is a server side example section therefore uses of outputChatBox server function

This event is triggered when a player entered vehicle.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerEnterVehicle on GTA Network Wiki].
}}

{{JSContainer|
*'''Known issue''': Client side this event is triggered when the player starts to enter the vehicle and not once they've completely sat down. This also causes the seat parameter to return 'undefined'.

{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which entered vehicle.
* '''vehicle''': {{RageType|Vehicle}} - The current [[:Category:Vehicle API|vehicle]] the player is sitting in.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.

{{Example}}
This example outputs chat message, when player is in the car.
<pre>
function playerEnterVehicleHandler(player, vehicle, seat) {
player.outputChatBox(`${player.name} got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerEnterVehicleDelegate(Vehicle vehicle, int seatId);
</syntaxhighlight>
{{Parameters}}
* '''vehicle''' - vehicle '''RAGE.Elements.Vehicle'''
* '''seatId''' - the id of the seat, expects'''System.Int32'''

{{Example}}
The example below sends a chat message to play when they enter a vehicle, showing whether they are driver or passenger.

<syntaxhighlight lang="csharp">
Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
{
if (seatId == -1)
{
RAGE.Chat.Output("You got in the driver's seat");
}
else
{
RAGE.Chat.Output("You got in a passenger seat");
}
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}} - The current [[:Category:Vehicle API|vehicle]] the player entered.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.

{{Example}}
<pre>
function playerEnterVehicleHandler(vehicle, seat) {
mp.gui.chat.push(`You got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Template:ClientsideCsJsFunction

2019-05-24T14:40:22Z

RoboN1X: Copying better format from Template:ClientsideCsJsEvent

<h1 style="padding: 4px 0px; border-bottom: 2px solid #ff704d; margin: 2px 0px 0px;">
<span style="float: left; width: 50%;">Client-Side</span>
<span style="float: right; width: 50%; text-align: right; color: #ff704d;">Function</span>
</h1>
{| class="wikitable" style="float: right; margin: 0px; border-top: 2px solid #eaecf0; border-right: 6px solid #eaecf0; border-bottom: 2px solid #eaecf0; border-left: 2px solid #eaecf0; background-color: #f8f9fa;"
|-
! [[File:c.png|30px|link=#{{{1|C#_Syntax}}}]] <span style="color: #8A2BE2">C#</span>
! [[File:js.png|25px|link=#{{{2|JavaScript_Syntax}}}]] JavaScript
|}
<br>

Template:ClientSideJS

2019-05-24T14:35:17Z

RoboN1X: old to new

#REDIRECT [[Template:ClientsideJsFunction]]

Template:ClientSideEventJS

2019-05-24T14:34:46Z

RoboN1X: old to new

#REDIRECT [[Template:ClientsideJsEvent]]

Note Template

2019-05-24T14:27:05Z

RoboN1X: RoboN1X moved page Note Template to Help:Note Template: non main topic of this wiki

#REDIRECT [[Help:Note Template]]

Help:Note Template

2019-05-24T14:27:05Z

RoboN1X: RoboN1X moved page Note Template to Help:Note Template: non main topic of this wiki

GuiReady

2019-05-24T14:13:47Z

RoboN1X:

Gets triggered when RAGE.Ui.DefaultWindow gets loaded and ready.

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnGuiReadyDelegate();
</syntaxhighlight>

{{Parameters}}
''This event requires no parameters''

{{Example}}
<syntaxhighlight lang="csharp">
Events.OnGuiReady += OnGuiReady;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnGuiReady()
{
RAGE.Chat.Output("Default window ready");
}
</syntaxhighlight>
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("guiReady", eventHandler);
</syntaxhighlight>
'''eventHandler''' is a function

{{Parameters}}
''This event requires no parameters''

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("guiReady", () => {
mp.gui.chat.push("GUI Ready");
});
</syntaxhighlight>
}}

[[Category:Client-side Event]]

GuiReady

2019-05-24T14:13:19Z

RoboN1X:

Gets triggered when RAGE.Ui.DefaultWindow gets loaded and ready.

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnGuiReadyDelegate();
</syntaxhighlight>

{{Parameters}}
''This event requires no parameters''

{{Example}}
<syntaxhighlight lang="csharp">
Events.OnGuiReady += OnGuiReady;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnGuiReady()
{
RAGE.Chat.Output("Default window ready");
}
</syntaxhighlight>
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("guiReady", eventHandler);
</syntaxhighlight>
'''eventHandler''' is a function

{{Parameters}}
''This event requires no parameters''
}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("guiReady", () => {
mp.gui.chat.push("GUI Ready");
});
</syntaxhighlight>
}}

[[Category:Client-side Event]]

EntityDataChangeByKey

2019-05-24T14:06:52Z

RoboN1X:

{{ClientsideCsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnEntityDataChangeByKey(ulong key, Entity entity, object arg);
</syntaxhighlight>

{{Parameters}}
* '''key''': key, expects '''System.UInt64''' type.
* '''entity''': entity, expects '''RAGE.Elements.Entity''' type.
* '''arg''': arg, expects '''System.Object''' type.

{{Example}}
The example below shows up a message for a player with the key.

<syntaxhighlight lang="csharp">
Events.EnableKeyDataChangeEvent = true;
Events.OnEntityDataChangeByKey += OnEntityDataChangeByKey;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnEntityDataChangeByKey(ulong key, RAGE.Elements.Entity entity, object arg)
{
RAGE.Chat.Output($"{key}");
}
</syntaxhighlight>
}}

== See also ==
* [[Events::addDataHandler]]

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

EventTriggeredByKey

2019-05-24T14:05:51Z

RoboN1X:

{{ClientsideCsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnEventTriggeredByKeyDelegate(ulong key, object[] args, CancelEventArgs cancel);
</syntaxhighlight>

{{Parameters}}
* '''key''' - expects '''System.UInt64'''
* '''args''' - expects '''System.Object''' Array
* '''cancel''' - expects '''RAGE.Events.CancelEventArgs'''

{{Example}}
The example below does nothing on invoke of event

<syntaxhighlight lang="csharp">
Events.EnableKeyRemoteEvent = true;
Events.OnEventTriggeredByKey += OnEventTriggeredByKey;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnEventTriggeredByKey(ulong key, object[] args, RAGE.Events.CancelEventArgs cancel)
{
//do something epic
}
</syntaxhighlight>
}}

[[Category:Client-side Event]]

EventTriggeredByKey

2019-05-24T14:04:42Z

RoboN1X: category

ClickWithRaycast

2019-05-24T14:03:34Z

RoboN1X: category

{{ClientsideCsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnClickWithRaycastDelegate(int x, int y, bool up, bool right, float relativeX, float relativeY, Vector3 worldPos, int entityHandle);
</syntaxhighlight>
{{Parameters}}
* '''x''' - expects '''System.Int32'''
* '''y''' - expects '''System.Int32'''
* '''up''' - expects '''System.Boolean'''
* '''right''' - expects '''System.Boolean'''
* '''relativeX''' - expects '''System.Single'''
* '''relativeY''' - expects '''System.Single'''
* '''worldPos''' - the position in the world, expects '''RAGE.Vector3 '''
* '''entityHandle''' - the handle of the entity, expects '''System.Int32'''

{{Example}}
The example below does nothing on invoke of event

<syntaxhighlight lang="csharp">
Events.OnClickWithRaycast += OnClickWithRaycast;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnClickWithRaycast(int x, int y, bool up, bool right, float relativeX, float relativeY, RAGE.Vector3 worldPos, int entityHandle)
{
//add something beast here
}
</syntaxhighlight>
}}

[[Category:Client-side Event]]

Template:Blip function

2019-05-24T13:53:59Z

RoboN1X: marked as deletion category

<noinclude>[[Category:Delete]]</noinclude>

Template:Blip functions serverside

2019-05-24T13:53:44Z

RoboN1X: marked as deletion category

<noinclude>[[Category:Delete]]</noinclude>

Blip::sprite

2019-05-24T13:53:01Z

RoboN1X: /* See Also */

This function is used to change the blip sprite.

==Syntax==
<pre>
blip.sprite = 40;
</pre>

==Example==
This will change a blip to a house.

{{ServersideCode|
<pre>
let createdBlip = mp.blips.new(1, new mp.Vector3(0, 0, 0));

createdBlip.sprite = 40;
</pre>
}}

==Blip sprites==
{{Blips_model}}

==See also==
{{Blip_definition}}

Template:Checkpoint function

2019-05-24T13:51:57Z

RoboN1X: marked as deletion category

<noinclude>[[Category:Delete]]</noinclude>

Template:ColshapePool block

2019-05-24T13:51:32Z

RoboN1X: marked as deletion category

<noinclude>[[Category:Delete]]</noinclude>

Vehicle::rotation

2019-05-24T13:50:05Z

RoboN1X: /* See Also */

This property is being used to get or set vehicle rotation.

==Getter==
* '''<span style="color:#008017>Vector3</span>'''

==Setter==
* '''<span style="color:#008017>Vector3</span>'''

== Example ==
{{ServersideCode|
<pre>
let rotation = vehicle.rotation;
vehicle.rotation = new mp.Vector3(0, 0, 90);
console.log(vehicle.rotation.x, vehicle.rotation.y, vehicle.rotation.z);
</pre>
}}

==See also==
{{Vehicle_definition}}

Template:Entity block

2019-05-24T13:49:45Z

RoboN1X: marked as deletion category

<noinclude>[[Category:Delete]]</noinclude>

EntityDataChange

2019-05-24T13:41:30Z

RoboN1X:

{{Warning|This event is replaced with [[Events::addDataHandler|addDataHandler function]] as of RAGE MP version 0.3.7}}

{{ClientsideCsJsEvent}}

{{JSContainer|
{{Example}}
<syntaxhighlight lang="javascript">
// Other player data changed
mp.events.add('entityDataChange', (entity, key, value) => {
if(entity.type == "player")
{
mp.gui.chat.push("Entitydata has been changed!");
}
});
</syntaxhighlight>
}}

[[Category:Deprecated]]

EntityDataChange

2019-05-24T13:41:15Z

RoboN1X:

{{Warning|This event is replaced with [[Events::addDataHandler|addDataHandler function]] as of RAGE MP version 0.3.7}}

{{ClientsideCsJsEvent}}

{{JSContainer|
==Example==
<syntaxhighlight lang="javascript">
// Other player data changed
mp.events.add('entityDataChange', (entity, key, value) => {
if(entity.type == "player")
{
mp.gui.chat.push("Entitydata has been changed!");
}
});
</syntaxhighlight>
}}

[[Category:Deprecated]]

EntityDataChange

2019-05-24T13:40:38Z

RoboN1X:

{{Warning|This event is replaced with [[Events::addDataHandler]] as of RAGEMP version 0.3.7.}}

{{ClientsideCsJsEvent}}

{{JSContainer|
==Example==
<syntaxhighlight lang="javascript">
// Other player data changed
mp.events.add('entityDataChange', (entity, key, value) => {
if(entity.type == "player")
{
mp.gui.chat.push("Entitydata has been changed!");
}
});
</syntaxhighlight>
}}

[[Category:Deprecated]]

AddDataHandler

2019-05-24T13:38:10Z

RoboN1X: Merged with new page

#REDIRECT [[Events::addDataHandler]]

Events::addDataHandler

2019-05-24T13:37:52Z

RoboN1X: Merged from old page https://wiki.rage.mp/index.php?title=AddDataHandler

This Function is used to alert client-side with entity's data change for a specified variable

{{ClientsideCsJsFunction}}

{{CSharpContainer|
<pre>
RAGE.events.AddDataHandler(string name, OnEntityDataChangeDelegate handler);
</pre>

{{Parameters}}
* '''name'''
* '''handler'''
}}

{{JSContainer|
<pre>
mp.events.addDataHandler(key, handlerFunction);
</pre>
{{Parameters}}
* '''key''': {{RageType|String}} - Shared data key's name.
* '''handlerFunction''': Handler function with parameters:
** '''entity''': {{RageType|Entity}} - The [[:Category:Entity API|entity]] that had the data change.
** '''value''': {{RageType|Any}} - The new value of the data key.

{{Example}}
<pre>
/*
Handles testVar change.
Do "player.data.testVar = 1234;" on server-side to trigger this.
*/

mp.events.addDataHandler("testVar", (entity, value) => {
mp.gui.chat.push(`testVar changed to ${value} on entity ${entity.handle}.`);
});
</pre>

{{Example}}
This example sets nickname for player and triggers players' clientside data handler

{{ServersideCode|
<pre>
mp.events.addCommand('setNick', (player, nickname) => {
player.setVariable('oldNick', player.name);
player.name = nickname;
player.setVariable('newNick', nickname);
});
</pre>
}}

{{ClientsideCode|
<pre>
mp.events.addDataHandler('newNick', function (entity, value) {
if (entity.type === 'player') mp.gui.chat.push(`${player.getVariable('oldNick')} has changed nickname to ${value}`)
})
</pre>
}}
}}

==See Also==
* [[EntityDataChangeByKey]]

{{Event_functions}}

[[Category:Entity API]]
[[Category:Shared Property]]
[[Category:Client-side Function]]

PlayerExitVehicle

2019-05-24T13:14:54Z

RoboN1X:

This event is triggered when a player went out from a vehicle.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitVehicle on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - [[:Category:Player API|player]], which left the vehicle
* '''vehicle''': {{RageType|Vehicle}} - [[:Category:Vehicle API|vehicle]], which was left by the player.

{{Example}}
This example outputs a console chat message, when player went out from vehicle.
<pre>
function playerExitVehicleHandler(player, vehicle) {
console.log(`${player.name} when out from vehicle with ID: ${vehicle.id}`);
}

mp.events.add("playerExitVehicle", playerExitVehicleHandler);
</pre>
}}

==See also==
* [[playerLeaveVehicle]]

{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]

PlayerLeaveVehicle

2019-05-24T13:14:22Z

RoboN1X:

Triggers when the player exits the vehicle.

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerLeaveVehicleDelegate();
</syntaxhighlight>
{{Parameters}}
''This event has no parameters''

{{Example}}
The example below send a chat message to the player when they exit a vehicle.

<syntaxhighlight lang="csharp">
Events.OnPlayerLeaveVehicle += OnPlayerLeaveVehicle();
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerLeaveVehicle()
{
RAGE.Chat.Output("You exited a vehicle");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Example}}
This example outputs chat message, when player start leave from the car.
<pre>
mp.events.add("playerLeaveVehicle", () => {
mp.gui.chat.push("Player start leave the vehicle");
})
</pre>
}}

==See Also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Client-side Event]]

Development with Visual Studio Code

2019-05-23T15:10:26Z

RoboN1X:

This tutorial explains a basic to develop & debug a RAGE-MP resource / server-side script using [[wikipedia:Visual_Studio_Code|VSCode]] on C# bridge

Note: it is not required for you to compile the .cs scripts to run the resource, you can let the server compile them when server starts.
[[#Client-side|See the comparison below]].

This tutorial will mainly describe about compiling your server-side resource into <tt>.dll</tt> binary which you can attach a debugger on it. A similar step can be also done in [[wikipedia:Visual Studio|Visual Studio IDE]], except the launch & task part.

== Requirement ==
* Visual Studio Code - [https://code.visualstudio.com/download Download]
* .NET Core SDK version 2.2 - [https://dotnet.microsoft.com/download/dotnet-core/2.2 Download] (As of RAGE:MP 0.3.7, Server side uses version 2.0.3 and Client side uses version 2.2.0 so it's safe to install the latest which are backward compatible)
* C# Extension for Visual Studio Code powered by OmniSharp - [https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp Download (in Visual Studio Code)]

== Setting Up Project ==
# Open Visual Studio Code on '''bridge/resources''' folder
# Create a new folder, example '''mygamemode''' then select the folder
# Open the terminal <kbd>'''Ctrl'''</kbd>+<kbd>'''`'''</kbd> (control + tilde)
# Enter <tt>></tt><code>dotnet new classlib -f netcoreapp2</code> to create a new .NET Core class library
# A <tt>.csproj</tt> file will be created, click to edit it
## [https://docs.microsoft.com/en-us/dotnet/standard/frameworks#how-to-specify-target-frameworks Change the TargetFramework] to <code>netcoreapp2.0</code>
## [https://docs.microsoft.com/en-us/dotnet/core/versions/selection#self-contained-deployments-include-the-selected-runtime Set the RuntimeFrameworkVersion] to 2.0.3
## Include <tt>GTANetworkAPI</tt> by adding reference to '''bridge/runtime/Bootstrapper.dll'''
## Your <tt>mygamemode.csproj</tt> should look like this:
<pre>
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netcoreapp2.0</TargetFramework>
<RuntimeFrameworkVersion>2.0.3</RuntimeFrameworkVersion>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>None</ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>
</PropertyGroup>

<ItemGroup>
<Reference Include="GTANetworkAPI">
<HintPath>..\..\runtime\Bootstrapper.dll</HintPath> 
<Private Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">False</Private>
</Reference>
</ItemGroup>

</Project>
</pre>
Save the files and enter in terminal: <tt>></tt><code>dotnet restore</code>.

== Setting up Launch and Task command ==
Visual Studio Code comes with two kind of project commands: '''launch.json''' and '''tasks.json'''

These commands are saved inside a .vscode folder of your project, so you have to do this on every different projects you created.

=== launch.json ===
The launch command is used for running server debug with <kbd>F5</kbd> key (or from '''Debug''' menu) later

# Proceed to Debugging Tab (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>)
# Click the Gear button (next to DEBUG button) to configure the <tt>launch.json</tt>, select ''.NET Core'' or ''Others''
# Modify the configuration like this:
<pre>
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "RAGE-MP Launch (build)",
"type": "coreclr",
"request": "launch",
"preLaunchTask": "compile",
"program": "server.exe", // The RAGEMP server executable
"args": [],
"cwd": "${workspaceFolder}/../../../", // Or absolute path to your X:/RAGEMP/server-files/
"stopAtEntry": false,
"console": "externalTerminal",
"internalConsoleOptions": "neverOpen"
}
]
}
</pre>
Save the <tt>launch.json</tt> file.

=== tasks.json ===
We will create two kind of tasks:
* '''compile''' - to compile the resource into <tt>.dll</tt>, required for debugging in launch task we created before (located in '''bin/Debug/''' by default)
* '''release''' - to build the end product of the resource with optimized <tt>.dll</tt> ready to deploy & run in real server (located in '''bin/Release/''' by default)

You can run these tasks by selecting '''Terminal'''>'''Run Task...''' later time.

# Select on menu bar '''Terminal'''>'''Configure Tasks...''', select ''.NET Core'' or ''Others''
# Modify the configuration like this:
<pre>
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "compile",
"type": "shell",
"command": "dotnet build",
"presentation": {
"reveal": "silent"
},
"problemMatcher": "$msCompile",
"group": {
"kind": "build",
"isDefault": true
},
"promptOnClose": true
},
{
"label": "release",
"type": "shell",
"command": "dotnet build -c Release",
"problemMatcher": "$msCompile",
"group": "build"
}
]
}
</pre>
Save the <tt>tasks.json</tt> file.

== Setting Up Resource ==
Now you can create your script in '''Class1.cs''', rename it if you wish (make sure the class name is also renamed)

=== Writing the gamemode ===
# Add the C# server-side bridge dependency with <code>using GTANetworkAPI</code>
# Extends your class to <tt>Script</tt> API like <code>public class Class1 : Script</code>
# Add <code>Hello World!</code> code in the entry point or class constructor of the script, your code would look like this:
<pre>
using System;
using GTANetworkAPI;

namespace mygamemode
{
public class Class1 : Script
{
public Class1()
{
Console.WriteLine("Hello World!");
}
}
}
</pre>
=== Configuring resource meta file ===
# Create a new file [https://wiki.gtanet.work/index.php?title=meta.xml meta.xml] in your resource folder (if not exist)
# Put some resource information, and add the <tt>mygamemode.dll</tt> file
<pre>
<meta>
<info name="My Gamemode" description="My C# bridge gamemode Resource" />



<script src="bin/Debug/netcoreapp2.0/mygamemode.dll" />
</meta>
</pre>
Note that after running compile task, your <tt>.cs</tt> scripts will be compiled into <tt>.dll</tt> by default located on <code>bin/Debug/netcoreapp2.0/</code> folder relative to your resource directory.

If you are not sure why your <tt>.dll</tt> does not work, try running the server with raw <tt>Class1.cs</tt> source code (uncomment the Uncompiled and comment the Compiled script tag).

=== Configuring bridge setting ===
# Edit '''bridge/[https://wiki.gtanet.work/index.php?title=settings.xml settings.xml]''' file in your server folder, add your resource like the following:
<pre>
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<acl_enabled>false</acl_enabled>
<resource src="mygamemode" />
</config>
</pre>
Save the files.

== Debugging the Script ==
When you are set up ready, it's time to build the resource!

If there are errors on compilation, try to close the folder and re-open it in your Visual Studio Code, usually the OmniSharp server need to refresh new files.

You can also try <tt>></tt><code>dotnet clean</code> in case you have changes on the referenced files (i.e. Bootstrapper update).

Since we have not added any gameplay code in this tutorial, we do not have to play & join the server.

# Open your script Class1.cs, add a code breakpoint by clicking on the left side of the line number
# For example, you may want to put a pause before the server prints "Hello World" line
<syntaxhighlight lang="csharp" highlight="10" start="8" line>
public Class1()
{
Console.WriteLine("Hello World!");
}
</syntaxhighlight>
# Go to Debug tab
# Hit <kbd>F5</kbd> button
# Your server will run, and the server threads will pause on your breakpoint line
# Click '''► Continue''' button (<kbd>F5</kbd>) on top of your Visual Studio window
# You will get output "Hello World" in your server console.
<pre>
Loading resources..
-> Starting mygamemode resource..
mygamemode: loading scripts...
mygamemode: instantiating mygamemode.Class1..
Hello world!
-> Resource mygamemode started!
</pre>
Close the server/hit the '''■ Stop''' debugging button (<kbd>Shift</kbd>+<kbd>F5</kbd>).

After you made changes to your script, you can always hit <kbd>F5</kbd> again to restart debugging.

== Deploying the Resource ==
Now that you have learn how to build and debug your script, later when your resource is ready, you may want to compile it with the Release task to deploy an optimized binary.

Simply, click on menu '''Terminal'''>'''Run Task...''' then select '''release'''

You can find your <tt>.dll</tt> in <code>bin/Release/netcoreapp2.0/</code> as you may notice it contains cleaner files, since we configured to not copy the <tt>.dll</tt> files from runtime folder with the <code><Private></code> option.
This build will be not debugable as the symbols are already removed and optimized for run time.

Proceed to upload these <tt>.dll</tt> file to your server, and be sure to set your '''meta.xml''' differently as it will be using the non-debugged version.
<pre>
<meta>
<info name="My Gamemode" description="My C# bridge gamemode Resource" />
<script src="bin/Release/netcoreapp2.0/mygamemode.dll" />
</meta>
</pre>

You might want to have the <tt>.pdb</tt> file together with it, it will create useful traceable dump in case your code causes server crash during runtime, even though it is not really possible to debug it.

== Client-side ==
You can also do similar thing to work with client-side scripts, except you do not deal with launch or task commands. However, please note that in RAGE MP Client-side C-Sharp scripts are NOT compiled nor build into <tt>.dll</tt>. Which means you cannot debug it like in this tutorial.

You can still make the project, reference to '''rage-sharp.dll''' in '''RAGEMP/dotnet/''' folder to get IntelliSense auto completion benefit in VSCode, similar way we did on Bootstrapper:
<pre>
<ItemGroup>
<Reference Include="RAGE">
<HintPath>..\..\..\dotnet\rage-sharp.dll</HintPath> 
<Private>False</Private>
</Reference>
</ItemGroup>
</pre>
And you just have to save the <tt>.cs</tt> file, they will be downloaded to your player's RAGE-MP client and will be compiled as how you configured it.

{| class="wikitable
|+ A brief comparison how C# works in RAGE-MP
|-
!
! Server-side Bridge (Compiled)
! Server-side (Raw)
! Client-side
|-
! Output
| [[wikipedia:Common Intermediate Language|IL]] "binary" (<tt>.dll</tt>)
| colspan="2" | C-Sharp source code (<tt>.cs</tt>)
|-
! Dependency
| colspan="2" | <tt>Bootstrapper.dll</tt> runtimes & <tt>bridge.dll</tt> plugin
| <tt>rage-sharp.dll</tt> runtimes
|-
! Compile Time
| By server developer with C# Compiler (in SDK)
| By <tt>server.exe</tt>
| By <tt>ragemp_v.exe</tt>
|-
! .NET Core Version
| colspan="2" | 2.0.3 <sup>1)</sup>
| 2.2.0 <sup>2)</sup>
|-
! Debugging
| Developer's debugger tool choice (in SDK)
| colspan="2" | RAGE MP app built in error handling & logging
|}
Notes:
* <sup>1)</sup> As of 0.3.7 based on <tt>.version</tt> file found in '''RAGEMP/server-files/bridge/runtime/''' folder
* <sup>2)</sup> As of 0.3.7 based on <tt>.version</tt> file found in '''RAGEMP/dotnet/''' folder

== See also ==
* [[Getting Started with Development]]
* [https://wiki.gtanet.work/index.php?title=Getting_Started_with_Development Getting started with Development on C# Bridge Server]
* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)
* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)
* [[Client-side events]] (or in [[Client-side_CSharp_events|C#]])
* [[Client-side functions]] (or in [[Client-side_CSharp_functions|C#]])

[[Category:Tutorials]]

Development with Visual Studio Code

2019-05-23T15:07:49Z

RoboN1X:

This tutorial explains a basic to develop & debug a RAGE-MP resource / server-side script using [[wikipedia:Visual_Studio_Code|VSCode]] on C# bridge

Note: it is not required for you to compile the .cs scripts to run the resource, you can let the server compile them when server starts.
[[#Client-side|See the comparison below]].

This tutorial will mainly describe about compiling your server-side resource into <tt>.dll</tt> binary which you can attach a debugger on it. A similar step can be also done in [[wikipedia:Visual Studio]], except the launch & task part.

== Requirement ==
* Visual Studio Code - [https://code.visualstudio.com/download Download]
* .NET Core SDK version 2.2 - [https://dotnet.microsoft.com/download/dotnet-core/2.2 Download] (As of RAGE:MP 0.3.7, Server side uses version 2.0.3 and Client side uses version 2.2.0 so it's safe to install the latest which are backward compatible)
* C# Extension for Visual Studio Code powered by OmniSharp - [https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp Download (in Visual Studio Code)]

== Setting Up Project ==
# Open Visual Studio Code on '''bridge/resources''' folder
# Create a new folder, example '''mygamemode''' then select the folder
# Open the terminal <kbd>'''Ctrl'''</kbd>+<kbd>'''`'''</kbd> (control + tilde)
# Enter <tt>></tt><code>dotnet new classlib -f netcoreapp2</code> to create a new .NET Core class library
# A <tt>.csproj</tt> file will be created, click to edit it
## [https://docs.microsoft.com/en-us/dotnet/standard/frameworks#how-to-specify-target-frameworks Change the TargetFramework] to <code>netcoreapp2.0</code>
## [https://docs.microsoft.com/en-us/dotnet/core/versions/selection#self-contained-deployments-include-the-selected-runtime Set the RuntimeFrameworkVersion] to 2.0.3
## Include <tt>GTANetworkAPI</tt> by adding reference to '''bridge/runtime/Bootstrapper.dll'''
## Your <tt>mygamemode.csproj</tt> should look like this:
<pre>
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netcoreapp2.0</TargetFramework>
<RuntimeFrameworkVersion>2.0.3</RuntimeFrameworkVersion>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>None</ResolveAssemblyWarnOrErrorOnTargetArchitectureMismatch>
</PropertyGroup>

<ItemGroup>
<Reference Include="GTANetworkAPI">
<HintPath>..\..\runtime\Bootstrapper.dll</HintPath> 
<Private Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">False</Private>
</Reference>
</ItemGroup>

</Project>
</pre>
Save the files and enter in terminal: <tt>></tt><code>dotnet restore</code>.

== Setting up Launch and Task command ==
Visual Studio Code comes with two kind of project commands: '''launch.json''' and '''tasks.json'''

These commands are saved inside a .vscode folder of your project, so you have to do this on every different projects you created.

=== launch.json ===
The launch command is used for running server debug with <kbd>F5</kbd> key (or from '''Debug''' menu) later

# Proceed to Debugging Tab (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>)
# Click the Gear button (next to DEBUG button) to configure the <tt>launch.json</tt>, select ''.NET Core'' or ''Others''
# Modify the configuration like this:
<pre>
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "RAGE-MP Launch (build)",
"type": "coreclr",
"request": "launch",
"preLaunchTask": "compile",
"program": "server.exe", // The RAGEMP server executable
"args": [],
"cwd": "${workspaceFolder}/../../../", // Or absolute path to your /RAGEMP/server-files/
"stopAtEntry": false,
"console": "externalTerminal",
"internalConsoleOptions": "neverOpen"
}
]
}
</pre>
Save the <tt>launch.json</tt> file.

=== tasks.json ===
We will create two kind of tasks:
* '''compile''' - to compile the resource into <tt>.dll</tt>, required for debugging in launch task we created before (located in '''bin/Debug/''' by default)
* '''release''' - to build the end product of the resource with optimized <tt>.dll</tt> ready to deploy & run in real server (located in '''bin/Release/''' by default)

You can run these tasks by selecting '''Terminal'''>'''Run Task...''' later time.

# Select on menu bar '''Terminal'''>'''Configure Tasks...''', select ''.NET Core'' or ''Others''
# Modify the configuration like this:
<pre>
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "compile",
"type": "shell",
"command": "dotnet build",
"presentation": {
"reveal": "silent"
},
"problemMatcher": "$msCompile",
"group": {
"kind": "build",
"isDefault": true
},
"promptOnClose": true
},
{
"label": "release",
"type": "shell",
"command": "dotnet build -c Release",
"problemMatcher": "$msCompile",
"group": "build"
}
]
}
</pre>
Save the <tt>tasks.json</tt> file.

== Setting Up Resource ==
Now you can create your script in '''Class1.cs''', rename it if you wish (make sure the class name is also renamed)

=== Writing the gamemode ===
# Add the C# server-side bridge dependency with <code>using GTANetworkAPI</code>
# Extends your class to <tt>Script</tt> API like <code>public class Class1 : Script</code>
# Add <code>Hello World!</code> code in the entry point or class constructor of the script, your code would look like this:
<pre>
using System;
using GTANetworkAPI;

namespace mygamemode
{
public class Class1 : Script
{
public Class1()
{
Console.WriteLine("Hello World!");
}
}
}
</pre>
=== Configuring resource meta file ===
# Create a new file [https://wiki.gtanet.work/index.php?title=meta.xml meta.xml] in your resource folder (if not exist)
# Put some resource information, and add the <tt>mygamemode.dll</tt> file
<pre>
<meta>
<info name="My Gamemode" description="My C# bridge gamemode Resource" />



<script src="bin/Debug/netcoreapp2.0/mygamemode.dll" />
</meta>
</pre>
Note that after running compile task, your <tt>.cs</tt> scripts will be compiled into <tt>.dll</tt> by default located on <code>bin/Debug/netcoreapp2.0/</code> folder relative to your resource directory.

If you are not sure why your <tt>.dll</tt> does not work, try running the server with raw <tt>Class1.cs</tt> source code (uncomment the Uncompiled and comment the Compiled script tag).

=== Configuring bridge setting ===
# Edit '''bridge/[https://wiki.gtanet.work/index.php?title=settings.xml settings.xml]''' file in your server folder, add your resource like the following:
<pre>
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<acl_enabled>false</acl_enabled>
<resource src="mygamemode" />
</config>
</pre>
Save the files.

== Debugging the Script ==
When you are set up ready, it's time to build the resource!

If there are errors on compilation, try to close the folder and re-open it in your Visual Studio Code, usually the OmniSharp server need to refresh new files.

You can also try <tt>></tt><code>dotnet clean</code> in case you have changes on the referenced files (i.e. Bootstrapper update).

Since we have not added any gameplay code in this tutorial, we do not have to play & join the server.

# Open your script Class1.cs, add a code breakpoint by clicking on the left side of the line number
# For example, you may want to put a pause before the server prints "Hello World" line
<syntaxhighlight lang="csharp" highlight="10" start="8" line>
public Class1()
{
Console.WriteLine("Hello World!");
}
</syntaxhighlight>
# Go to Debug tab
# Hit <kbd>F5</kbd> button
# Your server will run, and the server threads will pause on your breakpoint line
# Click '''► Continue''' button (<kbd>F5</kbd>) on top of your Visual Studio window
# You will get output "Hello World" in your server console.
<pre>
Loading resources..
-> Starting mygamemode resource..
mygamemode: loading scripts...
mygamemode: instantiating mygamemode.Class1..
Hello world!
-> Resource mygamemode started!
</pre>
Close the server/hit the '''■ Stop''' debugging button (<kbd>Shift</kbd>+<kbd>F5</kbd>).

After you made changes to your script, you can always hit <kbd>F5</kbd> again to restart debugging.

== Deploying the Resource ==
Now that you have learn how to build and debug your script, later when your resource is ready, you may want to compile it with the Release task to deploy an optimized binary.

Simply, click on menu '''Terminal'''>'''Run Task...''' then select '''release'''

You can find your <tt>.dll</tt> in <code>bin/Release/netcoreapp2.0/</code> as you may notice it contains cleaner files, since we configured to not copy the <tt>.dll</tt> files from runtime folder with the <code><Private></code> option.
This build will be not debugable as the symbols are already removed and optimized for run time.

Proceed to upload these <tt>.dll</tt> file to your server, and be sure to set your '''meta.xml''' differently as it will be using the non-debugged version.
<pre>
<meta>
<info name="My Gamemode" description="My C# bridge gamemode Resource" />
<script src="bin/Release/netcoreapp2.0/mygamemode.dll" />
</meta>
</pre>

You might want to have the <tt>.pdb</tt> file together with it, it will create useful traceable dump in case your code causes server crash during runtime, even though it is not really possible to debug it.

== Client-side ==
You can also do similar thing to work with client-side scripts, except you do not deal with launch or task commands. However, please note that in RAGE MP Client-side C-Sharp scripts are NOT compiled nor build into <tt>.dll</tt>. Which means you cannot debug it like in this tutorial.

You can still make the project, reference to '''rage-sharp.dll''' in '''RAGEMP/dotnet/''' folder to get IntelliSense auto completion benefit in VSCode, similar way we did on Bootstrapper:
<pre>
<ItemGroup>
<Reference Include="RAGE">
<HintPath>..\..\..\dotnet\rage-sharp.dll</HintPath> 
<Private>False</Private>
</Reference>
</ItemGroup>
</pre>
And you just have to save the <tt>.cs</tt> file, they will be downloaded to your player's RAGE-MP client and will be compiled as how you configured it.

{| class="wikitable
|+ A brief comparison how C# works in RAGE-MP
|-
!
! Server-side Bridge (Compiled)
! Server-side (Raw)
! Client-side
|-
! Output
| [[wikipedia:Common Intermediate Language|IL]] "binary" (<tt>.dll</tt>)
| colspan="2" | C-Sharp source code (<tt>.cs</tt>)
|-
! Dependency
| colspan="2" | <tt>Bootstrapper.dll</tt> runtimes & <tt>bridge.dll</tt> plugin
| <tt>rage-sharp.dll</tt> runtimes
|-
! Compile Time
| By server developer with C# Compiler (in SDK)
| By <tt>server.exe</tt>
| By <tt>ragemp_v.exe</tt>
|-
! .NET Core Version
| colspan="2" | 2.0.3 <sup>1)</sup>
| 2.2.0 <sup>2)</sup>
|-
! Debugging
| Developer's debugger tool choice (in SDK)
| colspan="2" | RAGE MP app built in error handling & logging
|}
Notes:
* <sup>1)</sup> As of 0.3.7 based on <tt>.version</tt> file found in '''RAGEMP/server-files/bridge/runtime/''' folder
* <sup>2)</sup> As of 0.3.7 based on <tt>.version</tt> file found in '''RAGEMP/dotnet/''' folder

== See also ==
* [[Getting Started with Development]]
* [https://wiki.gtanet.work/index.php?title=Getting_Started_with_Development Getting started with Development on C# Bridge Server]
* [[Server-side events]] (or in [https://wiki.gtanet.work/index.php?title=Scripting_Events C#] bridge)
* [[Server-side functions]] (or in [https://wiki.gtanet.work/index.php?title=Server_Scripting_Functions C#] bridge)
* [[Client-side events]] (or in [[Client-side_CSharp_events|C#]])
* [[Client-side functions]] (or in [[Client-side_CSharp_functions|C#]])

[[Category:Tutorials]]

VehicleHornToggle

2019-05-23T15:00:54Z

RoboN1X:

Event triggered when a vehicle's horn is toggled

{{ServersideJsEvent}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}}
* '''toggle''': {{RageType|Boolean}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("vehicleHornToggle", (vehicle, toggle) => {
// Do what you want.
});
</syntaxhighlight>
}}

== See also ==
* [[vehicleSirenToggle]]

[[Category:Vehicle]]
[[Category:Server-side Event]]

PlayerCommand

2019-05-23T14:53:32Z

RoboN1X:

This event is triggered when a player sends a command.

{{ServersideJsEvent}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - [[:Category:Player API|player]], who send command.
* '''command''': {{RageType|String}} - command (without slash) with arguments.

{{Example}}
This example will write "Hello!" to player, who will enter command /meetme into chatbox.s
<pre>
mp.events.add("playerCommand", (player, command) => {
const args = command.split(/[ ]+/);
const commandName = args.splice(0, 1)[0];

if (commandName === "meetme") {
player.outputChatBox("Hello!");
}
});
</pre>

{{Example}}
'''Detecting Invalid Commands: '''
<pre>
mp.events.add('playerCommand', (player, command) => {
player.outputChatBox(`${command} is not a valid command. Use /help to find a list of commands.`);
});
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerCommandDelegate(string cmd, CancelEventArgs cancel);
</syntaxhighlight>

{{Parameters}}
* '''cmd''': colshape, expects '''System.String''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
This example will set player restore player health to max when command '''/heal''' is used, or set players armour to max when command '''/armour''' is used.
<syntaxhighlight lang="c#">
Events.OnPlayerCommand += OnPlayerCommand;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerCommand(string cmd, RAGE.Events.CancelEventArgs cancel)
{
if (cmd == "heal")
{
RAGE.Elements.Player.LocalPlayer.SetHealth(100);
}
else if (cmd == "armour")
{
RAGE.Elements.Player.LocalPlayer.SetArmour(100);
}
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''command''': {{RageType|String}} - command (without slash) with arguments.

{{Example}}
This example will output info about entered command into client chatbox.

if you enter "/blah 123 566", it will output next message:
"You enter command a "blah", and all arguments it a [123,566]"
<pre>
mp.events.add("playerCommand", (command) => {
const args = command.split(/[ ]+/);
const commandName = args[0];

args.shift();

if (commandName === "blah") {
mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`);
}
});
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerExitVehicle

2019-05-23T14:45:54Z

RoboN1X:

This event is triggered when a player went out from a vehicle.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitVehicle on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - [[:Category:Player API|player]], which left the vehicle
* '''vehicle''': {{RageType|Vehicle}} - [[:Category:Vehicle API|vehicle]], which was left by the player.

{{Example}}
This example outputs a console chat message, when player went out from vehicle.
<pre>
function playerExitVehicleHandler(player, vehicle) {
console.log(`${player.name} when out from vehicle with ID: ${vehicle.id}`);
}

mp.events.add("playerExitVehicle", playerExitVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]

PlayerEnterVehicle

2019-05-23T14:44:07Z

RoboN1X:

VehicleSirenToggle

2019-05-23T14:42:08Z

RoboN1X:

Event triggered when a vehicle's siren is toggled

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnVehicleSirenToggle on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}}
* '''toggle''': {{RageType|Boolean}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("vehicleSirenToggle", (vehicle, toggle) => {
// Do what you want.
});
</syntaxhighlight>
}}

== See also ==
* [[vehicleHornToggle]]

[[Category:Vehicle]]
[[Category:Server-side Event]]

PlayerExitVehicle

2019-05-23T14:40:19Z

RoboN1X:

This event is triggered when a player went out from a vehicle.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitVehicle on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - [[:Category|Player API|player]], which left the vehicle
* '''vehicle''': {{RageType|Vehicle}} - [[:Category|Vehicle API|vehicle]], which was left by the player.

{{Example}}
This example outputs a console chat message, when player went out from vehicle.
<pre>
function playerExitVehicleHandler(player, vehicle) {
console.log(`${player.name} when out from vehicle with ID: ${vehicle.id}`);
}

mp.events.add("playerExitVehicle", playerExitVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]

EntityCreated

2019-05-23T14:35:19Z

RoboN1X:

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

{{ServersideJsEvent}}

{{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>
}}

{{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]]

EntityModelChange

2019-05-23T14:34:31Z

RoboN1X:

Event triggered when an entity model changes.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnEntityModelChange on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}}
* '''oldModel''': {{RageType|Number}} - hash of the old model

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("entityModelChange", (entity, oldModel) => {
// Do what you want.
});
</syntaxhighlight>
}}

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

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

EntityDestroyed

2019-05-23T14:33:40Z

RoboN1X:

Event triggered when an entity is destroyed

{{ServersideJsEvent}}

{{JSContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("entityDestroyed", entity => {
// Do what you want
});
</syntaxhighlight>
}}

{{ClientsideCsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnEntityDestroyedDelegate(Entity entity);
</syntaxhighlight>

{{Parameters}}
* '''entity''' - the destroyed entity, expects '''RAGE.Elements.Entity'''

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

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

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

EntityCreated

2019-05-23T14:30:52Z

RoboN1X:

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

{{ServersideJsEvent}}

{{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>
}}

{{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>
}}

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

{{Example}}
<pre>
mp.events.add("entityCreated", (entity) => {
// Do something
});
</pre>
}}

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

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

EntityCreated

2019-05-23T14:24:07Z

RoboN1X:

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

{{ServersideJsEvent}}

{{JSContainer|
{{Parameters}}
* '''entity''': {{RageType|Entity}} - the [[:Category:Entity|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>
}}

{{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]]

TrailerAttached

2019-05-23T14:19:12Z

RoboN1X:

Event triggered when a vehicle's trailer is attached.

{{ServersideJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnVehicleTrailerChange OnVehicleTrailerChange on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}}
* '''trailer''': {{RageType|Vehicle}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("trailerAttached", (vehicle, trailer) => {
// Do what you want.
});
</syntaxhighlight>
}}

[[Category:Vehicle]]
[[Category:Server-side Event]]

TrailerAttached

2019-05-23T14:17:24Z

RoboN1X:

Event triggered when a vehicle's trailer is attached.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnVehicleTrailerChange OnVehicleTrailer on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}}
* '''trailer''': {{RageType|Vehicle}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("trailerAttached", (vehicle, trailer) => {
// Do what you want.
});
</syntaxhighlight>
}}

[[Category:Vehicle]]
[[Category:Server-side Event]]

PlayerStartExitVehicle

2019-05-23T14:14:57Z

RoboN1X:

This event is triggered when a player starts exiting from a vehicle.

{{ServersideJsEvent}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which going out.

{{Example}}
This example outputs chat message, when player starts exit the vehicle.
<pre>
function playerStartExitVehicleHandler(player) {
const playerName = player.name;
const vehicleID = player.vehicle.id;

mp.players.broadcast(`${playerName} started to exit the vehiclewith ID: ${vehicleID}`);
}

mp.events.add("playerStartExitVehicle", playerStartExitVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]

PlayerEnterVehicle

2019-05-23T14:11:38Z

RoboN1X:

This event is triggered when a player entered vehicle.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerEnterVehicle on GTA Network Wiki].
}}

{{JSContainer|
*'''Known issue''': Client side this event is triggered when the player starts to enter the vehicle and not once they've completely sat down. This also causes the seat parameter to return 'undefined'.

{{Parameters}}
* '''player''': {{RageType|Player}}
* '''vehicle''': {{RageType|Vehicle}} - The current vehicle the player is sitting in.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.

{{Example}}
This example outputs chat message, when player is in the car.
<pre>
function playerEnterVehicleHandler(player, vehicle, seat) {
player.outputChatBox(`${player.name} got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerEnterVehicleDelegate(Vehicle vehicle, int seatId);
</syntaxhighlight>
{{Parameters}}
* '''vehicle''' - vehicle '''RAGE.Elements.Vehicle'''
* '''seatId''' - the id of the seat, expects'''System.Int32'''

{{Example}}
The example below sends a chat message to play when they enter a vehicle, showing whether they are driver or passenger.

<syntaxhighlight lang="csharp">
Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
{
if (seatId == -1)
{
RAGE.Chat.Output("You got in the driver's seat");
}
else
{
RAGE.Chat.Output("You got in a passenger seat");
}
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}} - The current vehicle the player entered.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.

{{Example}}
<pre>
function playerEnterVehicleHandler(vehicle, seat) {
mp.gui.chat.push(`You got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerStartEnterVehicle

2019-05-23T14:09:45Z

RoboN1X:

This event is triggered when a player starts to get into a vehicle. This event is cancellable.

{{ServersideJsEvent}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which sits down (serverside only)
* '''vehicle''': {{RageType|Vehicle}} - vehicle in which the player sits.
* '''seat''': {{RageType|Number}} - the place where he sits down.

{{Example}}
This example outputs a chat message when a player gets into a vehicle.
<pre>
function playerStartEnterVehicleHandler(player, vehicle, seat) {
const playerName = player.name;
const vehicleID = vehicle.id;

mp.players.broadcast(`${playerName} started to get into the car ID: ${vehicleID}. Seat: ${seat}`);
}

mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerStartEnterVehicleDelegate(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel);
</syntaxhighlight>
{{Parameters}}
* '''vehicle''' - vehicle '''RAGE.Elements.Vehicle'''
* '''seatId''' - the id of the seat, expects'''System.Int32'''
* '''cancel''' - cancel, expects '''RAGE.Events.CancelEventArgs'''

{{Example}}
The example below sends a message to client when they start to get in a vehicle, showing whether they are a driver or passenger.

<syntaxhighlight lang="csharp">
Events.OnPlayerStartEnterVehicle += OnPlayerStartEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerStartEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
{
if (seatId == -1)
{
RAGE.Chat.Output("You started to get in the driver's seat");
}
else
{
RAGE.Chat.Output("You started to get in a passenger seat");
}
}
</syntaxhighlight>
}}

{{JSContainer|
<pre>
// The player is not emmited client-side assuming it's you
function playerStartEnterVehicleHandler(vehicle, seat) {
const vehicleID = vehicle.id;

mp.game.graphics.notify(`You started to get into the car ID: ${vehicleID}. Seat: ${seat}`);
}

mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerResurrect

2019-05-23T14:05:29Z

RoboN1X:

This event is called everytime a player resurrects.

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerResurrectDelegate();
</syntaxhighlight>
{{Parameters}}
''This event has no parameters''

{{Example}}
The example below shows a chat message to the client when they respawn.

<syntaxhighlight lang="csharp">
Events.OnPlayerResurrect += OnPlayerResurrect;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerResurrect()
{
RAGE.Chat.Output($"YOU'RE ALIVE!?");
}
</syntaxhighlight>
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add('playerResurrect', () => {});
</syntaxhighlight>

{{Parameters}}
''This event has no parameters''

{{Example}}
The example below shows up a message for a player when he resurrects.

<syntaxhighlight lang="javascript">
mp.events.add('playerResurrect', () => {
mp.gui.chat.push('Like a fenix raised from the ashes, you came back to us!');
});
</syntaxhighlight>
}}

== See also ==
* [[playerSpawn]]

[[Category:Player]]
[[Category:Client-side Event]]

PlayerExitColshape

2019-05-23T14:00:12Z

RoboN1X:

This event is triggered when a player exits a colshape.

Default dimension for ColShapes is 0, and the player must be in the same dimension as the Colshape for them to collide.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitColShape on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which exited the colshape
* '''shape''': {{RageType|ColShape}} - The [[:Category:ColShape API|colshape]] the player left

{{Example}}
<pre>
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerExitColshapeHandler(player, shape) {
if(shape == someColShape) {
console.log(`${player.name} left the colshape!`);
}
}

mp.events.add("playerExitColshape", playerExitColshapeHandler);
</pre>
}}

{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerExitColshapeDelegate(Colshape colshape, CancelEventArgs cancel);
</syntaxhighlight>

{{Parameters}}
* '''colshape''': colshape, expects '''RAGE.Elements.Colshape''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
<syntaxhighlight lang="csharp">
Events.OnPlayerExitColshape += OnPlayerExitColshape;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerExitColshape(RAGE.Elements.Colshape colshape, RAGE.Events.CancelEventArgs cancel)
{
RAGE.Chat.Output($"You exited colshape id:{colshape.Id}");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''shape''': {{RageType|ColShape}}

{{Example}}
<pre>
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerExitColshapeHandler(shape) {
if(shape == someColShape) {
//Local player left the colshape
}
}

mp.events.add("playerExitColshape", playerExitColshapeHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:ColShape]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerEnterColshape

2019-05-23T13:58:49Z

RoboN1X:

This event is triggered when a player enters a colshape.

Default dimension for Colshapes is 0, and the player must be in the same dimension as the Colshape for them to collide.
{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerEnterColShape on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which entered the colshape
* '''shape''': {{RageType|ColShape}} - The [[:Category:ColShape API|colshape]] the player entered

{{Example}}
<pre>
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerEnterColshapeHandler(player, shape) {
if(shape == someColShape) {
console.log(`${player.name} entered the colshape`);
}
}

mp.events.add("playerEnterColshape", playerEnterColshapeHandler);
</pre>
}}

{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
public delegate void OnPlayerEnterColshapeDelegate(Colshape colshape, CancelEventArgs cancel);
</syntaxhighlight>

{{Parameters}}
* '''colshape''': colshape, expects '''RAGE.Elements.Colshape''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
<syntaxhighlight lang="csharp">
Events.OnPlayerEnterColshape += OnPlayerEnterColshape;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerEnterColshape(RAGE.Elements.Colshape colshape, RAGE.Events.CancelEventArgs cancel)
{
RAGE.Chat.Output($"You entered colshape id:{colshape.Id}");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''shape''': {{RageType|ColShape}}

{{Example}}
<pre>
mp.events.add('playerEnterColshape', (shape) => {
mp.game.graphics.notify(`You entered a colshape with id "${shape.id}".`);
});
</pre>
}}

=See also=
{{Player_events}}

[[Category:Player]]
[[Category:ColShape]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerEnterCheckpoint

2019-05-23T13:57:06Z

RoboN1X:

Event triggered when a player enters into a checkpoint

{{ServersideCsJsEvent}}
{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerEnterCheckpoint on GTA Network Wiki].
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", eventHandler);
</syntaxhighlight>
'''eventHandler''' expects function with:

{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who entered checkpoint.
* '''checkpoint''': {{RageType|Checkpoint}} - The [[:Category:Checkpoint API|checkpoint]] that player entered.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}

{{ClientsideCsJsEvent}}
{{CSharpContainer|
<pre>
public delegate void OnPlayerEnterCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel);
</pre>

{{Parameters}}
* '''checkpoint''': checkpoint, expects '''RAGE.Elements.Checkpoint''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
The example below shows a message to player with the position of the checkpoint they entered.

<syntaxhighlight lang="c#">
Events.OnPlayerEnterCheckpoint += OnPlayerEnterCheckpoint;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerEnterCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
Vector3 pos = checkpoint.Position;
RAGE.Chat.Output($"Player just entered the checkpoint at X{pos.X} Y{pos.Y} Z{pos.Z}");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''checkpoint''': {{RageType|Checkpoint}} The checkpoint.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", (checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}

== See also ==
* [[playerExitCheckpoint]]

[[Category:Player]]
[[Category:Checkpoint]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerExitCheckpoint

2019-05-23T13:56:47Z

RoboN1X:

Event triggered when a player leaves a checkpoint

{{ServersideCsJsEvent}}
{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerExitCheckpoint on GTA Network Wiki].
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", eventHandler);
</syntaxhighlight>
'''eventHandler''' expects a function with:

{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who exited checkpoint.
* '''checkpoint''': {{RageType|Checkpoint}} - The [[:Category:Checkpoint API|checkpoint]] that player exited.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", (player, checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<pre>
public delegate void OnPlayerExitCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel);
</pre>

{{Parameters}}
* '''checkpoint''': checkpoint, expects '''RAGE.Elements.Checkpoint''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
The example below shows a message to player with the position of the checkpoint they just exited.

<syntaxhighlight lang="csharp">
Events.OnPlayerExitCheckpoint += OnPlayerExitCheckpoint;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerExitCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
Vector3 pos = checkpoint.Position;
RAGE.Chat.Output($"Player just left the checkpoint at X{pos.X} Y{pos.Y} Z{pos.Z}");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''checkpoint''': {{RageType|Checkpoint}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerExitCheckpoint", (checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}

== See also ==
* [[playerEnterCheckpoint]]

[[Category:Player]]
[[Category:Checkpoint]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerEnterCheckpoint

2019-05-23T13:55:22Z

RoboN1X:

Event triggered when a player enters into a checkpoint

{{ServersideCsJsEvent}}
{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerEnterCheckpoint on GTA Network Wiki].
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", eventHandler);
</syntaxhighlight>
'''eventHandler''' expects function with:

{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] who entered checkpoint.
* '''checkpoint''': {{RageType|Checkpoint}} - The [[:Category:Checkpoint API|checkpoint]] that player entered.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", (player, checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}

{{ClientsideCsJsEvent}}
{{CSharpContainer|
<pre>
public delegate void OnPlayerEnterCheckpointDelegate(Checkpoint checkpoint, CancelEventArgs cancel);
</pre>

{{Parameters}}
* '''checkpoint''': checkpoint, expects '''RAGE.Elements.Checkpoint''' type.
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
The example below shows a message to player with the position of the checkpoint they entered.

<syntaxhighlight lang="c#">
Events.OnPlayerEnterCheckpoint += OnPlayerEnterCheckpoint;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerEnterCheckpoint(RAGE.Elements.Checkpoint checkpoint, RAGE.Events.CancelEventArgs cancel)
{
Vector3 pos = checkpoint.Position;
RAGE.Chat.Output($"Player just entered the checkpoint at X{pos.X} Y{pos.Y} Z{pos.Z}");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''checkpoint''': {{RageType|Checkpoint}} The checkpoint.

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("playerEnterCheckpoint", (checkpoint) => {
// Do what you want.
});
</syntaxhighlight>
}}

[[Category:Player]]
[[Category:Checkpoint]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]