OnPlayerQuit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Cancel Effect)
 
(2 intermediate revisions by 2 users not shown)
Line 30: Line 30:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- we register quitPlayer as a handler for the event
-- we register quitPlayer as a handler for the event
function quitPlayer ( quitType )
addEventHandler("onPlayerQuit", root,
-- send the message to the server telling players that the player has left.
function(quitType)
outputChatBox ( getPlayerName(source).. " has left the server (" .. quitType .. ")" )
outputChatBox(getPlayerName(source).." has left the server ("..quitType..")")
end
end
addEventHandler ( "onPlayerQuit", root, quitPlayer )
)
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Player events}}
{{See also/Server event|Player events}}

Latest revision as of 13:14, 25 January 2024

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.

Cancel effect

This event cannot be canceled.

Example

This example gets a quitting player's name and outputs that they left the server. 

-- we register quitPlayer as a handler for the event
addEventHandler("onPlayerQuit", root,
	function(quitType)
		outputChatBox(getPlayerName(source).." has left the server ("..quitType..")")
	end
)

See Also

Player events


Event functions


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