OnPlayerQuit - Revision history

LordHenry: /* Example */

2024-01-25T13:14:11Z

Example

← Older revision		Revision as of 13:14, 25 January 2024
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
	addEventHandler("onPlayerQuit", ~~getRootElement()~~,		addEventHandler("onPlayerQuit", root,
	function(quitType)		function(quitType)
	outputChatBox(getPlayerName(source).." has left the server ("..quitType..")")		outputChatBox(getPlayerName(source).." has left the server ("..quitType..")")

2024-01-25T13:13:22Z

Example

← Older revision		Revision as of 13:13, 25 January 2024
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
	addEventHandler("onPlayerQuit", getRootElement(), ~~function()~~		addEventHandler("onPlayerQuit", getRootElement(),
	function()		function(quitType)
	outputChatBox(getPlayerName(source).." has left the server ("..~~QuitType~~..")")		outputChatBox(getPlayerName(source).." has left the server ("..quitType..")")
	end		end
	)		)

2024-01-24T13:11:48Z

Example

← Older revision		Revision as of 13:11, 24 January 2024
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", getRootElement(), function()
	~~-- send the message to the server telling players that the player has left.~~		function()
	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}}

2023-12-06T17:00:17Z

Cancel Effect

← Older revision		Revision as of 17:00, 6 December 2023
Line 21:		Line 21:
	==Source==		==Source==
	The [[event system#Event source\|source]] of this event is the [[player]] that left the server.		The [[event system#Event source\|source]] of this event is the [[player]] that left the server.

			==Cancel effect==
			This event cannot be canceled.

	==Example==		==Example==

2018-09-27T03:02:28Z

← Older revision		Revision as of 03:02, 27 September 2018
Line 34:		Line 34:
	</syntaxhighlight>		</syntaxhighlight>

	==See ~~Also==~~		{{See also/Server event\|Player events}}
	~~===~~Player events~~===~~
	~~{{Player_events}}~~
	~~===Event functions===~~
	~~{{Event functions~~}}

2018-09-27T02:16:25Z

← Older revision		Revision as of 02:16, 27 September 2018
Line 34:		Line 34:
	</syntaxhighlight>		</syntaxhighlight>

	{{See ~~also/Server event\|~~Player events}}		==See Also==
			===Player events===
			{{Player_events}}
			===Event functions===
			{{Event functions}}

2018-04-02T21:33:16Z

Example

← Older revision		Revision as of 21:33, 2 April 2018
Line 23:		Line 23:

	==Example==		==Example==
	This example gets ~~the~~ quitting ~~client~~'s name and outputs that ~~he is gone~~		This example gets a quitting player's name and outputs that they left the server.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 31:		Line 31:
	outputChatBox ( getPlayerName(source).. " has left the server (" .. quitType .. ")" )		outputChatBox ( getPlayerName(source).. " has left the server (" .. quitType .. ")" )
	end		end
	addEventHandler ( "onPlayerQuit", ~~getRootElement()~~, quitPlayer )		addEventHandler ( "onPlayerQuit", root, quitPlayer )
	</syntaxhighlight>		</syntaxhighlight>

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

2018-04-02T21:32:05Z

Parameters

← Older revision		Revision as of 21:32, 2 April 2018
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.

2018-04-02T21:31:12Z

Parameters

← Older revision		Revision as of 21:31, 2 April 2018
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.

2018-04-02T21:30:52Z

Parameters

← Older revision		Revision as of 21:30, 2 April 2018
Line 8:		Line 8:
	</syntaxhighlight>		</syntaxhighlight>

	*'''quitType''': How the player left.		*'''quitType''': How the player left. Possible values:
	~~This argument can be~~:		** "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.