SetPlayerNametagText - Revision history

MarioKart: /* Syntax */ OOP syntax added

2014-07-15T04:53:52Z

Syntax: OOP syntax added

← Older revision		Revision as of 04:53, 15 July 2014
Line 9:		Line 9:
	bool setPlayerNametagText ( player thePlayer, string text )		bool setPlayerNametagText ( player thePlayer, string text )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[player]]:setNametagText\|nametagText\|getPlayerNametagText}}
	===Required Arguments===		===Required Arguments===
	<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->		<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->

Miki785 at 12:55, 3 July 2014

2014-07-03T12:55:50Z

← Older revision		Revision as of 12:55, 3 July 2014
Line 20:		Line 20:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This console command lets you change the name tag of lamers.		This console command lets you change the name tag of lamers.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 45:		Line 46:
	addCommandHandler ( "lamer", iHateLamers )		addCommandHandler ( "lamer", iHateLamers )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{Player_functions}}		{{Player_functions}}

TheNormalnij: /* Example */ fix

2014-05-27T20:19:06Z

Example: fix

Jumba: Changed getPlayerFromNick to getPlayerFromName

2009-12-31T18:49:59Z

Changed getPlayerFromNick to getPlayerFromName

← Older revision		Revision as of 18:49, 31 December 2009
Line 30:		Line 30:
	outputChatBox ( "You MUST define a player to change his name tag!" )		outputChatBox ( "You MUST define a player to change his name tag!" )
	else		else
	culprit = ~~getPlayerFromNick~~ ( playername )		culprit = getPlayerFromName ( playername )
	-- This variable stores the result of trying to find the player associated with the playername		-- This variable stores the result of trying to find the player associated with the playername
	-- that the user of the command specified		-- that the user of the command specified

Mekorea at 18:50, 7 October 2008

2008-10-07T18:50:18Z

← Older revision		Revision as of 18:50, 7 October 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This will change the text of a player's nickname in the world to something besides the nickname he chose. This will not change the player's actual nickname, it only changes the visible aspect inside the world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).		This will change the text of a player's nickname in the world to something besides the nickname he chose. This will not change the player's actual nickname, it only changes the visible aspect inside the world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).

Ransom at 08:44, 8 April 2008

2008-04-08T08:44:37Z

← Older revision		Revision as of 08:44, 8 April 2008
Line 1:		Line 1:
	~~{{Server function}}~~
	{{Needs_Checking\|Read my description. This function seems kinda silly if its only going to change the text of the tag inside the world on the player. --[[User:Ransom\|Ransom]] 21:58, 10 April 2007 (CDT)}}

	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->

Arc at 21:46, 15 August 2007

2007-08-15T21:46:59Z

← Older revision		Revision as of 21:46, 15 August 2007
Line 1:		Line 1:
			{{Server function}}
	{{Needs_Checking\|Read my description. This function seems kinda silly if its only going to change the text of the tag inside the world on the player. --[[User:Ransom\|Ransom]] 21:58, 10 April 2007 (CDT)}}		{{Needs_Checking\|Read my description. This function seems kinda silly if its only going to change the text of the tag inside the world on the player. --[[User:Ransom\|Ransom]] 21:58, 10 April 2007 (CDT)}}

	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This will change the text of a player's nickname in the world to something besides the nickname he ~~choose~~. This will not change the player's actual nickname, it only changes the visible aspect inside the world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).		This will change the text of a player's nickname in the world to something besides the nickname he chose. This will not change the player's actual nickname, it only changes the visible aspect inside the world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).

	==Syntax==		==Syntax==
Line 21:		Line 22:

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~		This console command lets you change the name tag of lamers.
	This ~~example does...~~
	~~<!-- 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">
	~~addCommandHandler ( "lamer", "ihatelamers" )~~		function iHateLamers ( thePlayer, commandName, playername )
	function ~~ihatelamers~~ ( ~~player~~, commandName, playername )		-- This is a command handler that activates on text "lamer" followed by the playername
	--This is a command handler that activates on text "lamer" followed by the playername		-- in the console. The playername argument was added as an extra function argument to store the
	--in the console. The playername argument was added as an extra ~~varible~~ to store the		-- name of the player whose text will be changed.
	--name of the player whose text will be changed.		if playername == false then
	if playername == false then		-- Prevents the command from running if the player did not specify a value for playername
	--Prevents the command from running if the player did not specify a value for playername		outputChatBox ( "You MUST define a player to change his name tag!" )
	outputChatBox ( "You MUST define a player to change his name tag!" )		else
	else		culprit = getPlayerFromNick ( playername )
	culprit = getPlayerFromNick ( playername )		-- This variable stores the result of trying to find the player associated with the playername
	--This ~~varible~~ stores the result of trying to find the player associated with the playername		-- that the user of the command specified
	--that the user of the command specified		if culprit ~= false then
	if culprit ~= false then		-- This checks to make sure a player nick was found. If it was not then the playername argument
	--This checks to make sure a player nick was found. If it was not then the playername argument		-- specified by the command user was not equivalent to the name of any players in the server
	--specified by the command user was not equivalent to the name of any players in the server		setPlayerNametagText ( culprit, "IM_LAME" )
	setPlayerNametagText ( culprit, "IM_LAME" )		-- finally, the nickname text is changed since the command arguments were checked and are valid
	--finally, the nickname text is changed since the command arguments were checked and are valid		else
	else		outputChatBox ( "Player does not exist!" )
	outputChatBox ( "Player does not exist!" )		end
	end		end
	end
	end		end
			addCommandHandler ( "lamer", iHateLamers )
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 07:21, 11 April 2007

2007-04-11T07:21:29Z

← Older revision		Revision as of 07:21, 11 April 2007
Line 52:		Line 52:
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{Player_functions}}		{{Player_functions}}
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Ransom at 02:59, 11 April 2007

2007-04-11T02:59:40Z

← Older revision		Revision as of 02:59, 11 April 2007
Line 3:		Line 3:
	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This will change the text of a player's nickname in the world to something besides the nickname he choose. This will not change the player's actual nickname, ~~except for~~ the visible aspect inside the ~~GTA~~ world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).		This will change the text of a player's nickname in the world to something besides the nickname he choose. This will not change the player's actual nickname, it only changes the visible aspect inside the world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).

	==Syntax==		==Syntax==

Ransom at 02:58, 11 April 2007

2007-04-11T02:58:42Z

← Older revision		Revision as of 02:58, 11 April 2007
Line 1:		Line 1:
			{{Needs_Checking\|Read my description. This function seems kinda silly if its only going to change the text of the tag inside the world on the player. --[[User:Ransom\|Ransom]] 21:58, 10 April 2007 (CDT)}}

	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This ~~fake function is~~ for ~~use with blah & blah~~ and ~~does blahblahblabhalbhl~~		This will change the text of a player's nickname in the world to something besides the nickname he choose. This will not change the player's actual nickname, except for the visible aspect inside the GTA world (you will see his original nickname in the scoreboard and will refer to his original name in scripts).

	==Syntax==		==Syntax==
Line 11:		Line 13:
	===Required Arguments===		===Required Arguments===
	<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->		<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
	*'''~~argumentName~~:''' ~~description~~		*'''thePlayer:''' The player whose nickname text you wish to change
			*'''text:''' The new nickname text that will be displayed
	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' description
	*'''~~argumentName3~~:''' ~~description~~

	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if ~~blah~~, ''false'' otherwise.		Returns ''true'' if successful, ''false'' otherwise.

	==Example==		==Example==
Line 28:		Line 25:
	<!-- 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 -->		<!-- 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">
	--This ~~line does~~...		addCommandHandler ( "lamer", "ihatelamers" )
	~~blabhalbalhb~~ --~~abababa~~		function ihatelamers ( player, commandName, playername )
	--~~This line~~ does ~~this...~~		--This is a command handler that activates on text "lamer" followed by the playername
	~~mooo~~		--in the console. The playername argument was added as an extra varible to store the
			--name of the player whose text will be changed.
			if playername == false then
			--Prevents the command from running if the player did not specify a value for playername
			outputChatBox ( "You MUST define a player to change his name tag!" )
			else
			culprit = getPlayerFromNick ( playername )
			--This varible stores the result of trying to find the player associated with the playername
			--that the user of the command specified
			if culprit ~= false then
			--This checks to make sure a player nick was found. If it was not then the playername argument
			--specified by the command user was not equivalent to the name of any players in the server
			setPlayerNametagText ( culprit, "IM_LAME" )
			--finally, the nickname text is changed since the command arguments were checked and are valid
			else
			outputChatBox ( "Player does not exist!" )
			end
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->		<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
	{{~~FunctionArea_functions~~}}		{{Player_functions}}
	[[Category:Incomplete]] -- leave this unless you complete the function		[[Category:Incomplete]] -- leave this unless you complete the function

← Older revision		Revision as of 20:19, 27 May 2014
Line 26:		Line 26:
	-- in the console. The playername argument was added as an extra function argument to store the		-- in the console. The playername argument was added as an extra function argument to store the
	-- name of the player whose text will be changed.		-- name of the player whose text will be changed.
	if playername ~~== false~~ then		if not playername then
	-- Prevents the command from running if the player did not specify a value for playername		-- Prevents the command from running if the player did not specify a value for playername
	outputChatBox ( "You MUST define a player to change his name tag!" )		outputChatBox ( "You MUST define a player to change his name tag!", thePlayer )
	else		else
	culprit = getPlayerFromName ( playername )		local culprit = getPlayerFromName ( playername )
	-- This variable stores the result of trying to find the player associated with the playername		-- This variable stores the result of trying to find the player associated with the playername
	-- that the user of the command specified		-- that the user of the command specified
	if culprit ~~~= false~~ then		if culprit then
	-- This checks to make sure a player nick was found. If it was not then the playername argument		-- This checks to make sure a player nick was found. If it was not then the playername argument
	-- specified by the command user was not equivalent to the name of any players in the server		-- specified by the command user was not equivalent to the name of any players in the server
Line 39:		Line 39:
	-- finally, the nickname text is changed since the command arguments were checked and are valid		-- finally, the nickname text is changed since the command arguments were checked and are valid
	else		else
	outputChatBox ( "Player does not exist!" )		outputChatBox ( "Player does not exist!", thePlayer )
	end		end
	end		end