IsElement

From Multi Theft Auto: Wiki
Revision as of 15:28, 29 July 2007 by Jbeta (talk | contribs)
Jump to navigation Jump to search

This function checks if a value is an element or not.

Syntax

bool isElement ( var theValue )

Required Arguments

  • theValue: The value that we want to check.

Returns

Returns true if the passed value is an element, false otherwise.

Example

This function kills a player when it's passed the player element, or his name.

function killPlayer2 ( argument )
	-- if the argument is an element, and also a player,
	if isElement( argument ) and getElementType( argument, "player" ) then
		-- kill him
		killPlayer ( argument )

	-- if it isn't an element, but a string, it could be a name
	elseif type ( argument ) == "string" then
		-- retrieve the player with that name
		local playerElement = getPlayerFromNick( argument )
		-- if a player with such a name exists,
		if playerElement then
			-- kill him
			killPlayer ( playerElement )
		end
	end
end

See Also