GetPlayerName: 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 -->
This function returns a string containing the name of the specified player.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getPlayerName ( player )
string getPlayerName ( player thePlayer )
</syntaxhighlight>  
</syntaxhighlight>
 
===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 -->
*'''argumentName:''' description


<!-- Only include this section below if there are optional arguments -->
===Required Arguments===
===Optional Arguments===  
* '''thePlayer:''' The player you want to get the name of.
{{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 -->
Returns a string containing the requested player's name, or ''false'' if the player passed to the function is invalid.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
This example outputs the local player name to the chatbox.
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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
--we get the local player
blabhalbalhb --abababa
local localPlayer = getLocalPlayer()
--This line does this...
--then we get his name
mooo
local localPlayerName = getPlayerName(localPlayer)
--and we output it to the chatbox
outputChatBox(localPlayerName)
</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 -->
{{Client player functions}}
{{FunctionArea_functions}}
[[Category:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 00:04, 13 April 2007

This function returns a string containing the name of the specified player.

Syntax

string getPlayerName ( player thePlayer )

Required Arguments

  • thePlayer: The player you want to get the name of.

Returns

Returns a string containing the requested player's name, or false if the player passed to the function is invalid.

Example

This example outputs the local player name to the chatbox. 

--we get the local player
local localPlayer = getLocalPlayer()
--then we get his name
local localPlayerName = getPlayerName(localPlayer)
--and we output it to the chatbox
outputChatBox(localPlayerName)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerName?oldid=7963"