OnPlayerQuit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 9: Line 9:


*'''quitType''': How the player left. Possible values:
*'''quitType''': How the player left. Possible values:
** Unknown
**''"Unknown"''
** Quit
**''"Quit"''
** Kicked
**''"Kicked"''
** Banned
**''"Banned"''
** Bad Connection
**''"Bad Connection"''
** Timed out
**''"Timed out"''


*'''reason''': If the player was kicked or banned, the reason given goes here. If the player was '''not''' kicked or banned, this will be false.
*'''reason''': If the player was kicked or banned, the reason given goes here. If the player was '''not''' kicked or banned, this will be false.

Revision as of 21:32, 2 April 2018

This event is triggered when a player disconnects from the server.

Parameters

string quitType, string reason, element responsibleElement
  • quitType: How the player left. Possible values:
    • "Unknown"
    • "Quit"
    • "Kicked"
    • "Banned"
    • "Bad Connection"
    • "Timed out"
  • reason: If the player was kicked or banned, the reason given goes here. If the player was not kicked or banned, this will be false.
  • responsibleElement: The element that was responsible for kicking or banning the player. This is commonly another player, but can also be the console element.

Source

The source of this event is the player that left the server.

Example

This example gets the quitting client's name and outputs that he is gone 

-- we register quitPlayer as a handler for the event
function quitPlayer ( quitType )
	-- send the message to the server telling players that the player has left.
	outputChatBox ( getPlayerName(source).. " has left the server (" .. quitType .. ")" )
end
addEventHandler ( "onPlayerQuit", getRootElement(), quitPlayer )

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerQuit?oldid=54403"