GetClientName - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:17:49Z

Changed "DeprecatedWithAlt" template to "Deprecated"

← Older revision		Revision as of 16:17, 13 February 2015
Line 1:		Line 1:
			__NOTOC__
	{{Server function}}		{{Server function}}
	{{~~DeprecatedWithAlt~~\|getPlayerName\|}}		{{Deprecated\|getPlayerName\|}}
	~~__NOTOC__~~

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

AlexTMjugador: Visual improvement

2014-06-25T14:22:58Z

Visual improvement

← Older revision		Revision as of 14:22, 25 June 2014
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
	{{~~Deprecated~~}}		{{DeprecatedWithAlt\|getPlayerName\|}}
	__NOTOC__		__NOTOC__

	~~Please use [[getPlayerName]]~~

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

Arran Fortuna at 21:24, 20 April 2011

2011-04-20T21:24:19Z

← Older revision		Revision as of 21:24, 20 April 2011
Line 2:		Line 2:
	{{Deprecated}}		{{Deprecated}}
	__NOTOC__		__NOTOC__

			Please use [[getPlayerName]]

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

Awwu at 14:25, 27 March 2009

2009-03-27T14:25:16Z

← Older revision		Revision as of 14:25, 27 March 2009
Line 1:		Line 1:
	{{Server function}}		{{Server function}}
			{{Deprecated}}
	__NOTOC__		__NOTOC__
	This function gets a [[client]]'s name (a client can either be a [[player]] or an admin).		This function gets a [[client]]'s name (a client can either be a [[player]] or an admin).

EAi at 15:33, 3 August 2007

2007-08-03T15:33:28Z

← Older revision		Revision as of 15:33, 3 August 2007
Line 1:		Line 1:
			{{Server function}}
	__NOTOC__		__NOTOC__
	This function gets a [[client]]'s name (a client can either be a [[player]] or an admin).		This function gets a [[client]]'s name (a client can either be a [[player]] or an admin).

Jbeta at 14:53, 25 April 2007

2007-04-25T14:53:59Z

← Older revision		Revision as of 14:53, 25 April 2007
Line 8:		Line 8:

	===Required Arguments===		===Required Arguments===
	* '''theClient:''' ~~The~~ [[client]] element (player or admin) you want to get the name of.		* '''theClient:''' the [[client]] element (player or admin) you want to get the name of.

	===Returns===		===Returns===

Jbeta at 14:53, 25 April 2007

2007-04-25T14:53:07Z

← Older revision		Revision as of 14:53, 25 April 2007
Line 1:		Line 1:
	~~{{Needs_Checking\|Outdated example? what is that get from id crap?--[[User:Ransom\|Ransom]] 02:47, 25 April 2007 (CDT)}}~~

	__NOTOC__		__NOTOC__
	This function ~~returns~~ a ~~string containing the~~ name ~~of the~~ client.		This function gets a [[client]]'s name (a client can either be a [[player]] or an admin).

	==Syntax==		==Syntax==
Line 10:		Line 8:

	===Required Arguments===		===Required Arguments===
	* '''theClient:''' The ~~client~~ [[~~element~~]] (player or admin) you want to get the name of.		* '''theClient:''' The [[client]] element (player or admin) you want to get the name of.

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

	==Example==		==Example==
	This example ~~finds~~ a player ~~with an ID of~~ '~~'1'' and if the player exists, they are killed~~.		This example adds a tag before a player's nick.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Find the player with ID 1.~~		function tagPlayer( thePlayer, tag )
	~~myPlayer = getPlayerFromID~~ ( 1 )		--we check thePlayer is a player, otherwise this function could be used with admins
	-- ~~If there~~ is a player with ~~an ID of 1 then...~~		if getElementType(thePlayer) == "player" then
	if ( ~~myPlayer ~~~= ~~false )~~ then		--we store the player's current name,
	-- ~~Try to kill~~ the player, ~~if it is successful then~~		local oldName = getClientName( thePlayer )
	~~if ( killPlayer~~ ( ~~myPlayer )~~ ) ~~then~~		--append the tag passed to this function before it,
	-- ~~Tell everyone about~~ it!		local taggedName = tag .. oldName
	~~outputServerChatBox ( "He shouldn't have had that ID~~. ~~", getClientName~~ ( ~~myPlayer )~~ , ~~" has bitten the dust."~~ )		--then set it as his new name
			setClientName( thePlayer, taggedName )
	end		end
	end		end

Ransom at 07:47, 25 April 2007

2007-04-25T07:47:27Z

← Older revision		Revision as of 07:47, 25 April 2007
Line 1:		Line 1:
			{{Needs_Checking\|Outdated example? what is that get from id crap?--[[User:Ransom\|Ransom]] 02:47, 25 April 2007 (CDT)}}

	__NOTOC__		__NOTOC__
	This function returns a string containing the name of the client.		This function returns a string containing the name of the client.

MrJax at 22:13, 22 July 2006

2006-07-22T22:13:00Z

← Older revision		Revision as of 22:13, 22 July 2006
Line 29:		Line 29:

	==See Also==		==See Also==
	{{~~Player~~ functions}}		{{Client functions}}

MrJax at 22:12, 22 July 2006

2006-07-22T22:12:43Z

New page

__NOTOC__
This function returns a string containing the name of the client.

==Syntax==
<syntaxhighlight lang="lua">
string getClientName ( client theClient )
</syntaxhighlight>

===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 finds a player with an ID of ''1'' and if the player exists, they are killed.
<syntaxhighlight lang="lua">
-- Find the player with ID 1.
myPlayer = getPlayerFromID ( 1 )
-- If there is a player with an ID of 1 then...
if ( myPlayer ~= false ) then
-- Try to kill the player, if it is successful then
if ( killPlayer ( myPlayer ) ) then
-- Tell everyone about it!
outputServerChatBox ( "He shouldn't have had that ID. ", getClientName ( myPlayer ) , " has bitten the dust." )
end
end
</syntaxhighlight>

==See Also==
{{Player functions}}