GetPlayerSerial - Revision history

Fernando187: Fix examples header

2025-06-08T13:33:59Z

Fix examples header

← Older revision		Revision as of 13:33, 8 June 2025
Line 31:		Line 31:
	</section>		</section>

	==~~Serverside examples~~==		==Examples==
	<section name="Server" class="server" show="true">		<section name="Server" class="server" show="true">
	This example creates a command with which player can check their own serial.		This example creates a command with which player can check their own serial.

LopSided at 16:15, 2 February 2024

2024-02-02T16:15:37Z

← Older revision		Revision as of 16:15, 2 February 2024
Line 2:		Line 2:
	{{Shared function}}		{{Shared function}}
	This function returns the [[serial]] for a specified [[player]].		This function returns the [[serial]] for a specified [[player]].
			{{Note\|It's possible for a player to fake the value returned from getPlayerSerial when used on the clientside. For this reason you should only trust the value returned by this function when used serverside. }}
	{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}		{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

LopSided at 15:58, 2 February 2024

2024-02-02T15:58:39Z

← Older revision		Revision as of 15:58, 2 February 2024
Line 22:		Line 22:
	string getPlayerSerial ( )		string getPlayerSerial ( )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[localPlayer]]:getSerial\|~~serial~~\|}}		{{OOP\|\|[[localPlayer]]:getSerial\|\|}}
	===Required Arguments===		===Required Arguments===
	None		None

LopSided: Update clientside usage info

2024-02-02T15:57:06Z

Update clientside usage info

← Older revision		Revision as of 15:57, 2 February 2024
Line 2:		Line 2:
	{{Shared function}}		{{Shared function}}
	This function returns the [[serial]] for a specified [[player]].		This function returns the [[serial]] for a specified [[player]].
	~~{{Note\|You shouldn't use client side version of [[getPlayerSerial]] function as it can return the wrong value for some players, and is potentially insecure.}}~~
	{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}		{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

	==Syntax==		==Syntax==
			<section name="Server" class="server" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getPlayerSerial ( player thePlayer )		string getPlayerSerial ( player thePlayer )
Line 15:		Line 15:
	==Returns==		==Returns==
	Returns the serial as a ''string'' if it was found, ''false'' otherwise.		Returns the serial as a ''string'' if it was found, ''false'' otherwise.
			</section>

			==Syntax==
			<section name="Client" class="client" show="true">
			<syntaxhighlight lang="lua">
			string getPlayerSerial ( )
			</syntaxhighlight>
			{{OOP\|\|[[localPlayer]]:getSerial\|serial\|}}
			===Required Arguments===
			None

			==Returns==
			Returns the serial as a ''string'' if it was found, ''false'' otherwise.
			</section>

	==Serverside examples==		==Serverside examples==

Tracer: Changed description

2023-07-21T19:10:18Z

Changed description

← Older revision		Revision as of 19:10, 21 July 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Server~~ function}}		{{Shared function}}
	This function returns the [[serial]] for a specified [[player]].		This function returns the [[serial]] for a specified [[player]].
	{{Note\|~~The~~ client side version of [[getPlayerSerial]] ~~has been deprecated~~ as it can return the wrong value for some players, and is potentially insecure~~. The following article assumes that the function is serverside only~~.}}		{{Note\|You shouldn't use client side version of [[getPlayerSerial]] function as it can return the wrong value for some players, and is potentially insecure.}}
	{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}		{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

Line 17:		Line 17:

	==Serverside examples==		==Serverside examples==
			<section name="Server" class="server" show="true">
	This example creates a command with which player can check their own serial.		This example creates a command with which player can check their own serial.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 70:		Line 71:
	)		)
	</syntaxhighlight>		</syntaxhighlight>
			</section>
	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

Srslyyyy: Add important note.

2023-06-24T16:05:25Z

Add important note.

← Older revision		Revision as of 16:05, 24 June 2023
Line 3:		Line 3:
	This function returns the [[serial]] for a specified [[player]].		This function returns the [[serial]] for a specified [[player]].
	{{Note\|The client side version of [[getPlayerSerial]] has been deprecated as it can return the wrong value for some players, and is potentially insecure. The following article assumes that the function is serverside only.}}		{{Note\|The client side version of [[getPlayerSerial]] has been deprecated as it can return the wrong value for some players, and is potentially insecure. The following article assumes that the function is serverside only.}}
			{{Important Note\|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

	==Syntax==		==Syntax==

Myonlake at 22:00, 21 February 2021

2021-02-21T22:00:44Z

← Older revision		Revision as of 22:00, 21 February 2021
Line 72:		Line 72:
	==See Also==		==See Also==
	{{Player functions}}		{{Player functions}}

			[[ar:getPlayerSerial]]
			[[en:GetPlayerSerial]]

AlexTMjugador: Typo at /* Serverside examples */

2017-10-13T16:51:47Z

Typo at Serverside examples

← Older revision		Revision as of 16:51, 13 October 2017
Line 56:		Line 56:
	-- Get the player serial and the allowed serial list for that account		-- Get the player serial and the allowed serial list for that account
	-- (If no serial is allowed for the account, do not allow the player to log in as a safety measure)		-- (If no serial is allowed for the account, do not allow the player to log in as a safety measure)
	local playerSerial, allowedSerials = getPlayerSerial(source), allowedAccountSerials[getAccountName(account)] or ""		local playerSerial, allowedSerials = getPlayerSerial(source), allowedAccountSerials[getAccountName(account)] or {}
	-- Check whether the client has an allowed serial or not		-- Check whether the client has an allowed serial or not
	for i = 1, #allowedSerials do		for i = 1, #allowedSerials do

AlexTMjugador: Removed all the ugly server sections and refactored the last two examples to be more correct and potentially less offensive

2016-04-21T17:00:11Z

Removed all the ugly server sections and refactored the last two examples to be more correct and potentially less offensive

← Older revision		Revision as of 17:00, 21 April 2016
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	This function returns the [[serial]] for a specified [[player]].		This function returns the [[serial]] for a specified [[player]].
	{{Note\|The client side version of [[getPlayerSerial]] has been deprecated as it can return the wrong value for some players, and is potentially insecure.}}		{{Note\|The client side version of [[getPlayerSerial]] has been deprecated as it can return the wrong value for some players, and is potentially insecure. The following article assumes that the function is serverside only.}}

	==Syntax==		==Syntax==
	~~<section name="Server" class="server" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string getPlayerSerial ( player thePlayer )		string getPlayerSerial ( player thePlayer )
Line 12:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''thePlayer:''' A [[player]] object referencing the specified player.		*'''thePlayer:''' A [[player]] object referencing the specified player.
	~~</section>~~

	==Returns==		==Returns==
	Returns the serial as a ''string'' if it was found, ''false'' otherwise.		Returns the serial as a ''string'' if it was found, ''false'' otherwise.

	==~~Example~~==		==Serverside examples==
	~~<section name="Example 1" class="server" show="true">~~
	This example creates a command with which player can check their own serial.		This example creates a command with which player can check their own serial.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 31:		Line 28:
	addCommandHandler( "myserial", checkMySerial )		addCommandHandler( "myserial", checkMySerial )
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~<section name="Example 2" class="server" show="true">~~		This example adds a command to ban a player's serial.
	This example ~~add~~ command to ban player serial.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~banSerial~~( source, command, ~~noob~~, reason )		local function banSerialCommand ( source, command, playerName, reason )
	if ~~( noob )~~ then		if playerName then
	local ~~theNoob~~ = getPlayerFromName( ~~noob~~ )		local player, serial = getPlayerFromName ( playerName ), getPlayerSerial ( playerName )
	~~local theNoobSerial =~~ getPlayerSerial( ~~theNoob~~ )		if player then
	if ~~( theNoob )~~ then		addBan ( serial, source, reason )
	addBan( ~~theNoobSerial~~, source, reason )
	end		end
	end		end
	end		end
	addCommandHandler( "~~banserial~~", ~~banSerial~~ )		addCommandHandler ( "banplayerserial", banSerialCommand )
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	~~<section name="Example 3" class="server" show="true">~~		This example only allows clients with a certain serial to log in into an account.
	This example ~~is Firewall Account Player by~~ serial ~~on Login~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~Firewall~~ =		local allowedAccountSerials =
	{		{
	[ ~~'AccountName'~~ ] = ~~'SerialPlayer',~~		-- List of allowed serials to log in into an account. Format:
	[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',		-- [ Account name ] = { Allowed serial array }
	[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',		[ "3ash8" ] = { "9C9F3B55D9D7BB7135FF274D3BF444E4" },
			[ "test5" ] = { "1D6F76CF8D7193792D13789849498452" },
	}		}

	addEventHandler ( 'onPlayerLogin', ~~getRootElement ( )~~,		addEventHandler("onPlayerLogin", root,
	function ( _, ~~theCurrentAccount~~ )		function(_, account)
	local ~~Serial~~ = ~~Firewall~~[getAccountName(~~theCurrentAccount~~)]		-- Get the player serial and the allowed serial list for that account
	~~if ( Serial ) then~~		-- (If no serial is allowed for the account, do not allow the player to log in as a safety measure)
	if ~~Serial ~~~= ~~getPlayerSerial ( source )~~ then		local playerSerial, allowedSerials = getPlayerSerial(source), allowedAccountSerials[getAccountName(account)] or ""
	~~banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )~~		-- Check whether the client has an allowed serial or not
			for i = 1, #allowedSerials do
			if allowedSerials[i] == playerSerial then
			-- The serial is allowed. Proceed with the normal log in proccess
			return
	end		end
	end		end
			-- If we reach this point the serial is not allowed. Do not let the player log in
			cancelEvent(true, "Client serial not allowed to log in into the account")
	end		end
	)		)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{~~Serial~~ functions}}		{{Player functions}}

Ccw at 11:12, 21 April 2016

2016-04-21T11:12:14Z

← Older revision		Revision as of 11:12, 21 April 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server ~~client~~ function}}		{{Server function}}
	This function returns the [[serial]] for a specified [[player]].		This function returns the [[serial]] for a specified [[player]].
	{{Note\|~~Client~~ side can return the wrong value for some players.}}		{{Note\|The client side version of [[getPlayerSerial]] has been deprecated as it can return the wrong value for some players, and is potentially insecure.}}

	==Syntax==		==Syntax==
Line 12:		Line 12:
	===Required Arguments===		===Required Arguments===
	*'''thePlayer:''' A [[player]] object referencing the specified player.		*'''thePlayer:''' A [[player]] object referencing the specified player.
	~~</section>~~
	~~<section name="Client" class="client" show="true">~~
	~~<syntaxhighlight lang="lua">~~
	~~string getPlayerSerial ( )~~
	~~</syntaxhighlight>~~
	~~{{OOP\|\|[[Player]].getSerial}}~~
	</section>		</section>

Line 55:		Line 49:
	</section>		</section>

	<section name="Example 3~~" class="client" show="true">~~		<section name="Example 3" class="server" show="true">
	~~This example add command to get client's serial.~~
	~~<syntaxhighlight lang="lua">~~
	~~function getMySerial( )~~
	~~local theSerial = getPlayerSerial()~~
	~~outputChatBox("Your serial is: "..tostring(theSerial))~~
	~~end~~
	~~addCommandHandler( "myserial", getMySerial )~~
	~~</syntaxhighlight>~~
	~~</section>~~

	~~<section name="Example 4~~" class="server" show="true">
	This example is Firewall Account Player by serial on Login		This example is Firewall Account Player by serial on Login
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">