GetPlayerNametagText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
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>


Revision as of 14:35, 19 August 2007

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

Syntax

string getPlayerNametagText ( player thePlayer )

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=10697"