GetPlayerNametagText - Revision history

MarioKart: /* Syntax */ OOP syntax added

2014-07-15T05:18:10Z

Syntax: OOP syntax added

← Older revision		Revision as of 05:18, 15 July 2014
Line 9:		Line 9:
	string getPlayerNametagText ( player thePlayer )		string getPlayerNametagText ( player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[player]]:getNametagText\|nametagText\|setPlayerNametagText}}
	===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 -->

NeonBlack: it's available for both server and client (since the fix of issue #4705 bugtracker)

2009-07-25T14:12:05Z

it's available for both server and client (since the fix of issue #4705 bugtracker)

← Older revision		Revision as of 14:12, 25 July 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{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 allow you to retrieve the name tag a player is currently using.		This will allow you to retrieve the name tag a player is currently using.

Arc at 14:35, 19 August 2007

2007-08-19T14:35:07Z

← Older revision		Revision as of 14:35, 19 August 2007
Line 16:		Line 16:
	===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 ''string'' with the nametag text, ''false'' if the player is invalid.		Returns a ''string'' with the nametag text, ''false'' if the player is invalid.

	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	<!-- 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 -->
	This will output the nametag text, of the player who enters the command 'myNametag'.		This will output the nametag text of the player who enters the command 'myNametag'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showNametag(~~player~~,command)		function showNametag ( thePlayer, command )
	local nameTag = getPlayerNametagText(~~player~~)		local nameTag = getPlayerNametagText ( thePlayer )
	outputChatBox("Your nametag text is: "..nameTag,~~player~~)		outputChatBox ( "Your nametag text is: " .. nameTag, thePlayer )
	end		end
	addCommandHandler("myNametag",showNametag)		addCommandHandler("myNametag", showNametag)
	</syntaxhighlight>		</syntaxhighlight>

Driver2 at 11:30, 7 August 2007

2007-08-07T11:30:41Z

← Older revision		Revision as of 11:30, 7 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server 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 allow you to retrieve the name tag a player is currently using.		This will allow you to retrieve the name tag a player is currently using.

Driver2 at 12:38, 27 July 2007

2007-07-27T12:38:43Z

← Older revision		Revision as of 12:38, 27 July 2007
Line 15:		Line 15:
	===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 successful~~, ''false'' ~~otherwise~~.		Returns ''string'' with the nametag text, ''false'' if the player is invalid.

	==Example==		==Example==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	<!-- 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 -->
	This will ~~announce that a player has entered a car whenever a~~ player enters ~~a car~~.		This will output the nametag text, of the player who enters the command 'myNametag'.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler ( "onVehicleEnter", root, "VehicleEnter" )~~		function showNametag(player,command)
	function ~~VehicleEnter~~ ( player, ~~seat, jacked~~ )		local nameTag = getPlayerNametagText(player)
	~~playersname~~ = getPlayerNametagText ( player )		outputChatBox("Your nametag text is: "..nameTag,player)
	~~--Store the name of the person who entered the car~~
	outputChatBox ( ~~playersname~~..~~" entered a car!"~~ )
	~~--output the name tag of the person who entered the car~~
	end		end
			addCommandHandler("myNametag",showNametag)
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 06:22, 11 April 2007

2007-04-11T06:22:55Z

← Older revision		Revision as of 06:22, 11 April 2007
Line 1:		Line 1:
	__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 allow you to retrieve the name tag a player is currently using.

	==Syntax==		==Syntax==
Line 11:		Line 11:
	===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 person whose name tag you want to retrieve

	~~<!-- 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==
	<!-- Explain what the example is in a single sentance -->		<!-- Explain what the example is in a single sentance -->
	~~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 -->		<!-- 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 -->
	This will announce whenever a player enters a car		This will announce that a player has entered a car whenever a player enters a car.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addEventHandler ( "onVehicleEnter", root, "VehicleEnter" )		addEventHandler ( "onVehicleEnter", root, "VehicleEnter" )
Line 40:		Line 33:
	==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~~

Ransom at 06:20, 11 April 2007

2007-04-11T06:20:20Z

← Older revision		Revision as of 06:20, 11 April 2007
Line 27:		Line 27:
	This example does...		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 -->		<!-- 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 -->
			This will announce whenever a player enters a car
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does.~~..		addEventHandler ( "onVehicleEnter", root, "VehicleEnter" )
	~~blabhalbalhb~~ --~~abababa~~		function VehicleEnter ( player, seat, jacked )
	~~--This line does this...~~		playersname = getPlayerNametagText ( player )
	~~mooo~~		--Store the name of the person who entered the car
			outputChatBox ( playersname.." entered a car!" )
			--output the name tag of the person who entered the car
			end
	</syntaxhighlight>		</syntaxhighlight>

MrJax at 18:37, 12 December 2006

2006-12-12T18:37:55Z

← Older revision		Revision as of 18:37, 12 December 2006
Line 6:		Line 6:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~returnType functionName~~ ( ~~arguments~~ )		string getPlayerNametagText ( player thePlayer )
	</syntaxhighlight>		</syntaxhighlight>

Ransom at 08:01, 21 November 2006

2006-11-21T08:01:55Z

New page

__NOTOC__

This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==

<syntaxhighlight lang="lua">
returnType functionName ( arguments )
</syntaxhighlight>

===Required Arguments===

*'''argumentName:''' description


===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description

===Returns===

Returns ''true'' if blah, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function