Difference between revisions of "GetPlayerName"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m
(player name limits)
Line 13: Line 13:
 
===Returns===
 
===Returns===
 
Returns a string containing the requested player's name, or ''false'' if the player passed to the function is invalid.
 
Returns a string containing the requested player's name, or ''false'' if the player passed to the function is invalid.
 +
 +
===Limits===
 +
* Player name can consist of ASCII characters between 33 and 126 are allowed (basic latin): 
 +
    <nowiki>!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~</nowiki>
 +
* Minimal player name length is 1 character.
 +
* Maximum player name length is 22 characters.
 +
* Player names are case-insensitive. It is not possible to have two clients with same name but different character case.
 +
  
 
==Example==
 
==Example==

Revision as of 05:46, 15 November 2011

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.

Limits

  • Player name can consist of ASCII characters between 33 and 126 are allowed (basic latin):
   !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
  • Minimal player name length is 1 character.
  • Maximum player name length is 22 characters.
  • Player names are case-insensitive. It is not possible to have two clients with same name but different character case.


Example

Click to collapse [-]
Server
addCommandHandler("myname",
  function(playerSource)
    outputChatBox("Your name: "..getPlayerName(playerSource), playerSource)
  end
)
Click to collapse [-]
Client

This example outputs the local player name to the chatbox.

addCommandHandler("myname",
  function()
   local localPlayerName = getPlayerName(getLocalPlayer())
   --and we output it to the chatbox
   outputChatBox(localPlayerName)
  end
)

See Also