PlayerQuit: Difference between revisions

From RAGE Multiplayer Wiki
m (without #)
No edit summary
Line 1: Line 1:
This event is triggered when a player quits the server.
This event is triggered when a player quits/disconnects/leaves the server.
 
{{ServersideCsJsEvent}}
{{ServersideCsJsEvent}}
{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerDisconnected on GTA Network Wiki].
}}
{{JSContainer|
{{JSContainer|
{{Parameters}}
{{Parameters}}
* '''player''' - player, which quit from the server
* '''player''': {{RageType|Player}} - player, which quit from the server
* '''exitType ''' - exit types:
* '''exitType''': {{RageType|String}} - exit types:
**''disconnect''
**''disconnect''
**''timeout''
**''timeout''
**''kicked''
**''kicked''
* '''reason''' - kick reason
* '''reason''': {{RageType|String}} - kick reason


{{Example}}
{{Example}}
Line 28: Line 34:
</pre>
</pre>
}}
}}
{{ClientsideCsJsEvent|2=JavaScript_Syntax_2}}
 
{{ClientsideCsJsEvent|1=C#_Syntax_2|2=JavaScript_Syntax_2}}
 
{{CSharpContainer|
{{CSharpContainer|
<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
public delegate void OnPlayerQuitDelegate(Player player);
public delegate void OnPlayerQuitDelegate(Player player);
</syntaxhighlight>
</syntaxhighlight>
Line 40: Line 48:
The example below shows up a message to the client when another player leaves the server.
The example below shows up a message to the client when another player leaves the server.


<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
Events.OnPlayerQuit += OnPlayerQuit;
Events.OnPlayerQuit += OnPlayerQuit;
</syntaxhighlight>
</syntaxhighlight>
<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
public void OnPlayerQuit(RAGE.Elements.Player player)
public void OnPlayerQuit(RAGE.Elements.Player player)
{
{
Line 50: Line 58:
</syntaxhighlight>
</syntaxhighlight>
}}
}}
{{JSContainer|
{{JSContainer|
{{Parameters}}
{{Parameters}}
* {{RageType|Player}} - the other player who left the server
* '''player''': {{RageType|Player}} - the other player who left the server


{{Example}}
{{Example}}
This example outputs a notification, when another player disconnected from server.
This example displays a notification for the player, when another player disconnected from server.
<pre>
<pre>
mp.events.add("playerQuit", (player) => {
mp.events.add("playerQuit", (player) => {

Revision as of 13:11, 23 May 2019

This event is triggered when a player quits/disconnects/leaves the server.

Server-Side
Event

 C#  JavaScript




C# Syntax


JavaScript Syntax

Parameters

  • player: Player - player, which quit from the server
  • exitType: String - exit types:
    • disconnect
    • timeout
    • kicked
  • reason: String - kick reason

Example

This example outputs chat message, when player quits or kicked from the server. 

function playerQuitHandler(player, exitType, reason) {
  let str = player.name;

  if (exitType != "kicked") {
    str += " quit.";
  } else {
    str = ` kicked. Reason: ${reason}.`;
  }

  console.log(str);
}

mp.events.add("playerQuit", playerQuitHandler);


Client-Side Event

 C#  JavaScript



C# Syntax

public delegate void OnPlayerQuitDelegate(Player player);

Parameters

  • player: The player leaving the server, expects RAGE.Elements.Player type.

Example

The example below shows up a message to the client when another player leaves the server. 

Events.OnPlayerQuit += OnPlayerQuit;

public void OnPlayerQuit(RAGE.Elements.Player player)
{
    RAGE.Chat.Output($"Player {player.Name} has left");
}


JavaScript Syntax

Parameters

  • player: Player - the other player who left the server

Example

This example displays a notification for the player, when another player disconnected from server. 

mp.events.add("playerQuit", (player) => {
    mp.game.graphics.notify(`<C>${player.name}</C> (ID:${player.remoteId}) left the server`);
});


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint

Retrieved from "https://wiki.rage.mp/w/index.php?title=PlayerQuit&oldid=17607"