GetClientName

From Multi Theft Auto: Wiki
Revision as of 21:24, 20 April 2011 by Arran Fortuna (talk | contribs)
Jump to navigation Jump to search

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


Please use getPlayerName

This function gets a client's name (a client can either be a player or an admin).

Syntax

string getClientName ( client theClient )

Required Arguments

  • theClient: the client element (player or admin) you want to get the name of.

Returns

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

Example

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

function tagPlayer( 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

See Also

BEFORE VERSION 1.0 :