OnPlayerDisconnected: Difference between revisions

From RAGE Multiplayer Wiki
(Created page with "This event is triggered when a player '''leaves''' the server. {{CSharpContainer| {{#tag:syntaxhighlight| [ServerEvent(Event.PlayerDisconnected)] |lang=csharp }} {{Parameter...")
 
(Fixed "SendChatMesasge" to "SendChatMessage")
 
(One intermediate revision by one other user not shown)
Line 8: Line 8:


{{Parameters}}
{{Parameters}}
*'''player:''' parameter input should be in '''Client''' type
*'''player:''' parameter input should be in '''Player''' type
*'''type:''' parameter input should be in '''DisconnectionType''' type
*'''type:''' parameter input should be in '''DisconnectionType''' type
*'''reason:''' parameter input should be in '''string''' type
*'''reason:''' parameter input should be in '''string''' type
Line 15: Line 15:
{{#tag:syntaxhighlight|
{{#tag:syntaxhighlight|
[ServerEvent(Event.PlayerDisconnected)]
[ServerEvent(Event.PlayerDisconnected)]
public void OnPlayerDisconnect(Client client, DisconnectionType type, string reason)
public void OnPlayerDisconnect(Player player, DisconnectionType type, string reason)
{
{
switch (type)  
switch (type)  
{
{
case DisconnectionType.Left:
case DisconnectionType.Left:
client.SendMessage($"~b~{player.Name}~w~ has quit the server.");
player.SendChatMessage($"~b~{player.Name}~w~ has quit the server.");
break;
break;
case DisconnectionType.Timeout:
case DisconnectionType.Timeout:
client.SendMessage($"~b~{player.Name}~w~ has timed out.");
player.SendChatMessage($"~b~{player.Name}~w~ has timed out.");
break;
break;
case DisconnectionType.Kicked:
case DisconnectionType.Kicked:
client.SendMessage($"~b~{player.Name}~w~ was kicked from the server {reason}.");
player.SendChatMessage($"~b~{player.Name}~w~ was kicked from the server {reason}.");
break;
break;
}
}

Latest revision as of 19:17, 13 May 2021

This event is triggered when a player leaves the server.


C# Syntax

[ServerEvent(Event.PlayerDisconnected)]

Parameters

  • player: parameter input should be in Player type
  • type: parameter input should be in DisconnectionType type
  • reason: parameter input should be in string type

Example

[ServerEvent(Event.PlayerDisconnected)]
public void OnPlayerDisconnect(Player player, DisconnectionType type, string reason)
{
	switch (type) 
	{
		case DisconnectionType.Left:
			player.SendChatMessage($"~b~{player.Name}~w~ has quit the server.");
			break;
		case DisconnectionType.Timeout:
			player.SendChatMessage($"~b~{player.Name}~w~ has timed out.");
			break;
		case DisconnectionType.Kicked:
			player.SendChatMessage($"~b~{player.Name}~w~ was kicked from the server {reason}.");
			break;
	}
}