GetPlayerFromNick

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( player, command, who )
	local thePlayer = getPlayerFromNick(who) -- find the player that was specified in the command
	if (thePlayer ~= false) then -- if a player was found
		local x,y,z = getElementPosition(player) -- save the position of the player who entered the command
		local xp,yp,zp = getElementPosition(thePlayer) -- 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..")",player) -- output the message
	end
end
addCommandHandler("locate",locatePlayer)

See Also

• getPlayerTeam
• getPlayerBlurLevel
• setPlayerBlurLevel
• getPlayerSerial
• forcePlayerMap
• getPlayerScriptDebugLevel
• getPlayerFromName
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerWantedLevel
• givePlayerMoney
• isPlayerMapForced
• isPlayerNametagShowing
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• takePlayerMoney
• countPlayersInTeam
• getPlayersInTeam
• isVoiceEnabled
• setControlState
• getControlState