GetPlayerFromNick

From Multi Theft Auto: Wiki
Revision as of 00:48, 18 May 2006 by EAi (talk | contribs)
Jump to navigation Jump to search

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 called Someguy, and if he is found, he is killed and a message is displayed.

-- Find the player with the nickname 'Someguy'
player = getPlayerFromNick ( "Someguy" )
-- If a player was returned (false is returned if the player isn't found)
if ( player ~= false )
	-- If the player was killed succesfully then
	if ( killPlayer ( player ) ) then
		-- Say so in the chat
		serverChat ( "Someguy was found, and eliminated" )
	end
end

See Also

Template:Player Functions