PlayerQuit: Difference between revisions
m (Replaced HTML with template) |
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 the server. | ||
{{ServersideCsJsEvent}} | |||
{{JSContainer| | |||
{{Parameters}} | |||
* '''player''' - player, which quit from the server | * '''player''' - player, which quit from the server | ||
* '''exitType ''' - exit types: | * '''exitType ''' - exit types: | ||
| Line 9: | Line 10: | ||
* '''reason''' - kick reason | * '''reason''' - kick reason | ||
{{Example}} | |||
This example outputs chat message, when player quits or kicked from the server. | This example outputs chat message, when player quits or kicked from the server. | ||
<pre> | <pre> | ||
function playerQuitHandler(player, exitType, reason) { | function playerQuitHandler(player, exitType, reason) { | ||
| Line 27: | Line 27: | ||
mp.events.add("playerQuit", playerQuitHandler); | mp.events.add("playerQuit", playerQuitHandler); | ||
</pre> | </pre> | ||
}} | |||
{{ClientsideCsJsEvent}} | |||
{{CSharpContainer| | |||
<syntaxhighlight lang="c#"> | |||
public delegate void OnPlayerQuitDelegate(Player player); | |||
</syntaxhighlight> | |||
{{Parameters}} | |||
* '''player''': The player leaving the server, expects '''RAGE.Elements.Player''' type. | |||
{{Example}} | |||
The example below shows up a message to a player when another player leaves the server. | |||
<syntaxhighlight lang="c#"> | |||
Events.OnPlayerQuit += OnPlayerQuit; | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="c#"> | |||
public void OnPlayerQuit(RAGE.Elements.Player player) | |||
{ | |||
RAGE.Chat.Output($"Player {player.Name} has left"); | |||
} | |||
</syntaxhighlight> | |||
}} | |||
{{JSContainer| | |||
Missing difference | |||
}} | }} | ||
==See also== | ==See also== | ||
{{Player_events}} | {{Player_events}} | ||
Revision as of 09:44, 29 November 2018
This event is triggered when a player quits the server.
Server-Side Event
 C#
|
 JavaScript
|
|---|
JavaScript Syntax
Parameters
- player - player, which quit from the server
- exitType - exit types:
- disconnect
- timeout
- kicked
- reason - 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 a player 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
Missing difference
See also
Checkpoint
Colshape
Entity
Player
- playerChat
- playerCommand
- playerDamage
- playerDeath
- playerJoin
- playerQuit
- playerReady
- playerSpawn
- playerWeaponChange
Streaming
Vehicle
- playerStartEnterVehicle
- playerEnterVehicle
- playerStartExitVehicle
- playerExitVehicle
- trailerAttached
- vehicleDamage
- vehicleDeath
- vehicleHornToggle
- vehicleSirenToggle