OnPlayerQuit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added resp. argument, updated list, updated example.)
No edit summary
Line 42: Line 42:


{{See also/Server event|Player events}}
{{See also/Server event|Player events}}
[[Category:Incomplete]]

Revision as of 05:48, 18 May 2009

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

Parameters

string quitType, string reason, element responsibleElement
  • quitType: How the player left.

This argument can be:

  • "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 )
	-- we store the player's name
	local quittingPlayerName = getClientName ( source )
	-- and send the message to the server
	outputChatBox ( quittingPlayerName .. " 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=19629"