GetPlayerNametagText: Difference between revisions

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

Revision as of 06:22, 11 April 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 true if successful, false otherwise.

Example

This will announce that a player has entered a car whenever a player enters a car. 

addEventHandler ( "onVehicleEnter", root, "VehicleEnter" )
function VehicleEnter ( player, seat, jacked )
playersname = getPlayerNametagText ( 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

See Also


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