SetClientName

This function changes the specified client's name.

Syntax

bool setClientName ( client theClient, string newName )

Required Arguments

• theClient: the client that will have its name set.
• newName: the new name to set for the client.

Returns

Returns true if the client's name was changed succesfully, false if invalid arguments are specified.

Example

This example adds a tag before a player's nick.

function tagPlayer( command, thePlayer, tag )
	--we check thePlayer is a player, otherwise this function could be used with admins
	if getElementType( thePlayer ) == "player" then
		--we store the player's current name,
		local oldName = getClientName( thePlayer )
		--append the tag passed to this function before it,
		local taggedName = tag .. oldName
		--then set it as his new name
		setClientName( thePlayer, taggedName )
	end
end
--Add a command handler for either the console or / chat commands
--Example: /changetag <playername> <tag>
addCommandHandler ( "changetag", tagPlayer )

See Also

BEFORE VERSION 1.0 :

• getClientAccount
• getClientIP
• getClientName
• setClientName