GetPlayerName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Syntax: OOP syntax added)
Line 7: Line 7:
string getPlayerName ( player thePlayer )
string getPlayerName ( player thePlayer )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[player]]:getName|name|setPlayerName}}
===Required Arguments===
===Required Arguments===
* '''thePlayer:''' the Player that you want to get his name
* '''thePlayer:''' the Player that you want to get his name
Line 20: Line 20:
* Maximum player name length is 22 characters.
* 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.
* 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:20, 15 July 2014

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

Syntax

string getPlayerName ( player thePlayer )

OOP Syntax Help! I don't understand this!

Method: player:getName(...)
Variable: .name
Counterpart: setPlayerName


Required Arguments

  • thePlayer: the Player that you want to get his name

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