GetPlayerNametagText: Difference between revisions

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


Revision as of 12:38, 27 July 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 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(player,command)
	local nameTag = getPlayerNametagText(player)
	outputChatBox("Your nametag text is: "..nameTag,player)
end
addCommandHandler("myNametag",showNametag)

See Also


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