OnPlayerConnect - Revision history

Megadreams: Remove unnecessary comment about "if-else hell"

2024-06-03T21:29:00Z

Remove unnecessary comment about "if-else hell"

← Older revision		Revision as of 21:29, 3 June 2024
Line 34:		Line 34:
	if playerNick == "Player" then -- check if his nick is "Player"		if playerNick == "Player" then -- check if his nick is "Player"
	cancelEvent(true, 'The nick "Player" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.')		cancelEvent(true, 'The nick "Player" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.')
	return ~~-- early return; avoid if-else hell~~		return
	end		end
	-- output some data about the player		-- output some data about the player
Line 44:		Line 44:
	addEventHandler("onPlayerConnect", root, playerConnect)		addEventHandler("onPlayerConnect", root, playerConnect)
	</syntaxhighlight>		</syntaxhighlight>
	~~<!-- More info about if-else hell:~~
	~~https://www.freecodecamp.org/news/so-youre-in-if-else-hell-here-s-how-to-get-out-of-it-fc6407fec0e/~~
	~~https://www.reddit.com/r/programminghorror/comments/bbxnol/ifelse_hell/?rdt=64996~~
	~~-->~~

	This example cancels connection if player uses older MTA (older than 1.0.3)		This example cancels connection if player uses older MTA (older than 1.0.3)

Tracer: Improved examples; added comment about if-else hell

2023-10-30T07:38:53Z

Improved examples; added comment about if-else hell

← Older revision		Revision as of 07:38, 30 October 2023
Line 28:		Line 28:

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~
	This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.		This example cancels connection attempts of people who use the nick "Player" or outputs some data about the connecting player otherwise.
	~~<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--when a player connects		--when a player connects
	function playerConnect(playerNick, playerIP, playerUsername, playerSerial)		function playerConnect(playerNick, playerIP, playerUsername, playerSerial)
	if (playerNick == "Player") then --check if his nick is "Player"		if playerNick == "Player" then -- check if his nick is "Player"
	cancelEvent(true, "The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --~~in that case refuse the connection~~		cancelEvent(true, 'The nick "Player" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.')
	~~else~~		return -- early return; avoid if-else hell
	--output some data about the player		end
	outputChatBox(playerNick.." just connected to the server.")		-- output some data about the player
	outputChatBox("IP: "..playerIP.." / Username: "..playerUsername.." / Serial: "..playerSerial)		outputChatBox(playerNick.." just connected to the server.")
	~~end~~		outputChatBox("IP: "..playerIP.." / Username: "..playerUsername.." / Serial: "..playerSerial)
	end		end

	--add the playerConnect function as a handler for onPlayerConnect		--add the playerConnect function as a handler for onPlayerConnect
	addEventHandler("onPlayerConnect", ~~getRootElement()~~, playerConnect)		addEventHandler("onPlayerConnect", root, playerConnect)
	</syntaxhighlight>		</syntaxhighlight>
			<!-- More info about if-else hell:
			https://www.freecodecamp.org/news/so-youre-in-if-else-hell-here-s-how-to-get-out-of-it-fc6407fec0e/
			https://www.reddit.com/r/programminghorror/comments/bbxnol/ifelse_hell/?rdt=64996
			-->

	This example cancels connection if player uses older MTA (older than 1.0.3)		This example cancels connection if player uses older MTA (older than 1.0.3)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function versionCheck(_,_,_,_, clientVersion)		function versionCheck(_,_,_,_, clientVersion)
	if (clientVersion < 259) then		if clientVersion < 259 then
	cancelEvent(true, "Update your MTA before you join this server!")		cancelEvent(true, "Update your MTA before you join this server!")
	end		end
	end		end
	addEventHandler("onPlayerConnect", ~~getRootElement()~~, versionCheck)		addEventHandler("onPlayerConnect", root, versionCheck)
	</syntaxhighlight>		</syntaxhighlight>

IManGaaX at 07:05, 30 October 2023

2023-10-30T07:05:36Z

← Older revision		Revision as of 07:05, 30 October 2023
Line 33:		Line 33:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--when a player connects		--when a player connects
	function playerConnect (playerNick, playerIP, playerUsername, playerSerial~~, playerVersionNumber~~)		function playerConnect(playerNick, playerIP, playerUsername, playerSerial)
	if playerNick == "Player" then --check if his nick is "Player"		if (playerNick == "Player") then --check if his nick is "Player"
	cancelEvent(true,"The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection		cancelEvent(true, "The nick \"Player\" is not allowed, please change it to something else. You can change your nick in Settings menu Multiplayer tab.") --in that case refuse the connection
	else		else
	--output some data about the player		--output some data about the player
	outputChatBox (playerNick.." just connected to the server.")		outputChatBox(playerNick.." just connected to the server.")
	outputChatBox ("IP: "..playerIP.." Username: "..playerUsername.." Serial: "..playerSerial)		outputChatBox("IP: "..playerIP.." / Username: "..playerUsername.." / Serial: "..playerSerial)
	end		end
	end		end

	--add the playerConnect function as a handler for onPlayerConnect		--add the playerConnect function as a handler for onPlayerConnect
	addEventHandler ("onPlayerConnect", getRootElement(), playerConnect)		addEventHandler("onPlayerConnect", getRootElement(), playerConnect)
	</syntaxhighlight>		</syntaxhighlight>

	This example cancels connection if player uses older MTA (older than 1.0.3)		This example cancels connection if player uses older MTA (older than 1.0.3)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler( "onPlayerConnect", getRootElement(),~~		function versionCheck(_,_,_,_, clientVersion)
	function ( _,_,_,_, clientVersion )		if (clientVersion < 259) then
	if ( clientVersion < 259 ) then		cancelEvent(true, "Update your MTA before you join this server!")
	cancelEvent( true, "Update your MTA before you join this server!" );
	~~end~~
	end		end
	)		end
			addEventHandler("onPlayerConnect", getRootElement(), versionCheck)
	</syntaxhighlight>		</syntaxhighlight>

Myonlake at 17:09, 13 February 2019

2019-02-13T17:09:03Z

← Older revision		Revision as of 17:09, 13 February 2019
Line 7:		Line 7:
	message = '''WARNING:'''		message = '''WARNING:'''
	* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).		* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).
	* If you want to set custom ~~refuse connection info~~, [[cancelEvent]] '''~~must~~ be called at the end''' of the onPlayerConnect event~~. Otherwise it is likely~~ the client will be displayed ~~an empty reason~~.		* If you want to set custom disconnect text, [[cancelEvent]] '''should be called at the end''' of the onPlayerConnect event, otherwise the client will be displayed the default text if any other event, native or custom, is triggered before cancelling.
	}}		}}
	==Parameters==		==Parameters==

Myonlake at 17:02, 13 February 2019

2019-02-13T17:02:29Z

← Older revision		Revision as of 17:02, 13 February 2019
Line 7:		Line 7:
	message = '''WARNING:'''		message = '''WARNING:'''
	* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).		* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).
	* If you want to set custom refuse connection info, [[cancelEvent]] '''must be called at end''' of onPlayerConnect event. Otherwise it is likely the client will be displayed an empty reason.		* If you want to set custom refuse connection info, [[cancelEvent]] '''must be called at the end''' of the onPlayerConnect event. Otherwise it is likely the client will be displayed an empty reason.
	}}		}}
	==Parameters==		==Parameters==

Myonlake at 17:01, 13 February 2019

2019-02-13T17:01:57Z

← Older revision		Revision as of 17:01, 13 February 2019
Line 7:		Line 7:
	message = '''WARNING:'''		message = '''WARNING:'''
	* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).		* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).
	* If you want to set custom refuse connection info, [[cancelEvent]] must be ~~applied~~ at end of onPlayerConnect event.		* If you want to set custom refuse connection info, [[cancelEvent]] '''must be called at end''' of onPlayerConnect event. Otherwise it is likely the client will be displayed an empty reason.
	}}		}}
	==Parameters==		==Parameters==

Myonlake at 15:58, 13 February 2019

2019-02-13T15:58:24Z

← Older revision		Revision as of 15:58, 13 February 2019
Line 5:		Line 5:
	bordercolorhex = CC3333 \|		bordercolorhex = CC3333 \|
	bgcolorhex = FF8888 \|		bgcolorhex = FF8888 \|
	message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before ~~'''~~[[onPlayerJoin]]~~'''~~ to avoid desynchronization (e.g. [[setPlayerName]]). }}		message = '''WARNING:'''
	~~{{MessageBox\|~~		* You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before [[onPlayerJoin]] to avoid desynchronization (e.g. [[setPlayerName]]).
	~~bordercolorhex = CC3333 \|~~		* If you want to set custom refuse connection info, [[cancelEvent]] must be applied at end of onPlayerConnect event.
	~~bgcolorhex = FF8888 \|~~		}}
	~~message = '''WARNING:'''~~ If you want to set custom refuse connection info, [[cancelEvent]] must be applied at end of onPlayerConnect event}}
	==Parameters==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Myonlake at 15:57, 13 February 2019

2019-02-13T15:57:14Z

← Older revision		Revision as of 15:57, 13 February 2019
Line 5:		Line 5:
	bordercolorhex = CC3333 \|		bordercolorhex = CC3333 \|
	bgcolorhex = FF8888 \|		bgcolorhex = FF8888 \|
	message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before '''onPlayerJoin''' to avoid desynchronization (e.g. [[setPlayerName]]). }}		message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before '''[[onPlayerJoin]]''' to avoid desynchronization (e.g. [[setPlayerName]]). }}
	{{MessageBox\|		{{MessageBox\|
	bordercolorhex = CC3333 \|		bordercolorhex = CC3333 \|

CrosRoad95 at 10:46, 11 December 2018

2018-12-11T10:46:35Z

← Older revision		Revision as of 10:46, 11 December 2018
Line 6:		Line 6:
	bgcolorhex = FF8888 \|		bgcolorhex = FF8888 \|
	message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before '''onPlayerJoin''' to avoid desynchronization (e.g. [[setPlayerName]]). }}		message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before '''onPlayerJoin''' to avoid desynchronization (e.g. [[setPlayerName]]). }}
			{{MessageBox\|
			bordercolorhex = CC3333 \|
			bgcolorhex = FF8888 \|
			message = '''WARNING:''' If you want to set custom refuse connection info, [[cancelEvent]] must be applied at end of onPlayerConnect event}}
	==Parameters==		==Parameters==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Botder at 03:01, 27 September 2018

2018-09-27T03:01:03Z

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

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

	[[ru:onPlayerConnect]]		[[ru:onPlayerConnect]]

← Older revision		Revision as of 15:57, 13 February 2019
Line 5:		Line 5:
	bordercolorhex = CC3333 \|		bordercolorhex = CC3333 \|
	bgcolorhex = FF8888 \|		bgcolorhex = FF8888 \|
	message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before '''onPlayerJoin''' to avoid desynchronization (e.g. [[setPlayerName]]). }}		message = '''WARNING:''' You should never, under any circumstances, modify the player returned by [[getPlayerFromName]] before '''[[onPlayerJoin]]''' to avoid desynchronization (e.g. [[setPlayerName]]). }}
	{{MessageBox\|		{{MessageBox\|
	bordercolorhex = CC3333 \|		bordercolorhex = CC3333 \|