GetPlayerNametagText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(→‎Syntax: OOP syntax added)
 
(7 intermediate revisions by 5 users not shown)
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 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==  
<!-- 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>  
 
{{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 -->
*'''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 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 -->
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 output the nametag text of the player who enters the command 'myNametag'.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function showNametag ( thePlayer, command )
blabhalbalhb --abababa
local nameTag = getPlayerNametagText ( thePlayer )
--This line does this...
outputChatBox ( "Your nametag text is: " .. nameTag, thePlayer )
mooo
end
addCommandHandler("myNametag", showNametag)
</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

Latest revision as of 05:18, 15 July 2014

This will allow you to retrieve the name tag a player is currently using.

Syntax

string getPlayerNametagText ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:getNametagText(...)
Variable: .nametagText
Counterpart: setPlayerNametagText


Required Arguments

  • thePlayer: The person whose name tag you want to retrieve

Returns

Returns a string with the nametag text, false if the player is invalid.

Example

This will output the nametag text of the player who enters the command 'myNametag'. 

function showNametag ( thePlayer, command )
	local nameTag = getPlayerNametagText ( thePlayer )
	outputChatBox ( "Your nametag text is: " .. nameTag, thePlayer )
end
addCommandHandler("myNametag", showNametag)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerNametagText?oldid=40793"