GetPlayerFromNick: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Changed "DeprecatedWithAlt" template to "Deprecated" for the last time)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function returns a [[player]] object from a name.
{{Deprecated|getPlayerFromName|}}
 
This function returns a [[player]] [[element]] for the player with the name passed to the function.


==Syntax==
==Syntax==
[[player]] [[FindPlayer]] ( string name )
<syntaxhighlight lang="lua">
player getPlayerFromNick ( string playerName )
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
* '''name''': A string containing the name of the player you want to reference
* '''playerName''': A string containing the name of the player you want to reference
 
===Returns===
Returns a [[player]] [[element]] for the player with the nickname provided. If there is no player with that name, ''false'' is returned.


==Example==
==Example==
player = [[getPlayerFromNick]] ( "Vandalite" )
This example finds a [[player]] as specified in the command and outputs the direction and distance he is from the player who entered the command. For example: 'locate someguy'.
if ( [[killPlayer]] ( player ) ) then
<syntaxhighlight lang="lua">
  [[ serverChat ]] ( "Vandalite was found, and eliminated" )
function locatePlayer( sourcePlayer, command, who )
end
local targetPlayer = getPlayerFromNick ( who )               -- find the player that was specified in the command
if ( targetPlayer ) then                                      -- if a player was found
local x,y,z = getElementPosition ( sourcePlayer )    -- save the position of the player who entered the command
local xp,yp,zp = getElementPosition ( targetPlayer ) -- save the position of the player who should be located
local dir = nil
if (yp > y) then
dir = "N"
else
dir = "S"
end
if (xp > x) then
dir = dir .. "E"
else
dir = dir .. "W"
end
local distance = math.ceil ( getDistanceBetweenPoints3D(x, y, z, xp, yp, zp) )
outputChatBox( who .. " found " .. dir .. " (" .. distance .. ")", sourcePlayer) -- output the message
end
end
addCommandHandler ( "locate", locatePlayer )
</syntaxhighlight>
 
==See Also==
{{Player functions}}

Latest revision as of 16:45, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPlayerFromName instead.


This function returns a player element for the player with the name passed to the function.

Syntax

player getPlayerFromNick ( string playerName )

Required Arguments

  • playerName: A string containing the name of the player you want to reference

Returns

Returns a player element for the player with the nickname provided. If there is no player with that name, false is returned.

Example

This example finds a player as specified in the command and outputs the direction and distance he is from the player who entered the command. For example: 'locate someguy'. 

function locatePlayer( sourcePlayer, command, who )
	local targetPlayer = getPlayerFromNick ( who )                -- find the player that was specified in the command
	if ( targetPlayer ) then                                      -- if a player was found
		local x,y,z = getElementPosition ( sourcePlayer )     -- save the position of the player who entered the command
		local xp,yp,zp = getElementPosition ( targetPlayer )  -- save the position of the player who should be located
		local dir = nil
		if (yp > y) then
			dir = "N"
		else
			dir = "S"
		end
		if (xp > x) then
			dir = dir .. "E"
		else
			dir = dir .. "W"
		end
		local distance = math.ceil ( getDistanceBetweenPoints3D(x, y, z, xp, yp, zp) )
		outputChatBox( who .. " found " .. dir .. " (" .. distance .. ")", sourcePlayer) -- output the message
	end
end
addCommandHandler ( "locate", locatePlayer )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerFromNick?oldid=44621"