SetPlayerName
Description:
Function SetPlayerName sets the name of a player.
|
Parameters:
(playerid, const name[])
int | playerid | The ID of the player to set the name of. |
string | name | {{{3}}} |
Return Values:
- 1 The name was changed successfully
- 0 The name is already in use (including by this player at the moment) or the player specified is not connected
- -1 The name can not be changed (too long or has invalid characters)
Examples:
// Command simply sets the player's name to to "Superman" if possible, with no error checking or messages. if(strcmp(cmdtext, "/superman", true) == 0) { SetPlayerName(playerid, "Superman"); return 1; } // Command sets the players name to "Superman" if possible, informs the player of // any errors using a "switch" statement. if(strcmp(cmdtext, "/superman", true) == 0) { switch(SetPlayerName(playerid, "Superman")) { case -1: SendClientMessage(playerid, 0xFF0000FF, "Unable to change your name, someone else is known as 'Superman' already."); case 0: SendClientMessage(playerid, 0xFF0000FF, "You are already known as 'Superman'"); case 1: SendClientMessage(playerid, 0x00FF00FF, "You are now known as 'Superman'"); } return 1; }
Related Functions
The following functions may be useful, as they are related to this function in one way or another.
- GetPlayerName: Get a player's name.