Difference between revisions of "IsElement"

From Multi Theft Auto: Wiki
Jump to: navigation, search
m (Added template, sections, minor changes)
m
Line 4: Line 4:
  
 
==Syntax==
 
==Syntax==
<section name="Server and client" class="both" show="true">
 
 
<syntaxhighlight lang="lua">bool isElement ( var theValue )</syntaxhighlight>
 
<syntaxhighlight lang="lua">bool isElement ( var theValue )</syntaxhighlight>
  
Line 12: Line 11:
 
===Returns===
 
===Returns===
 
Returns ''true'' if the passed value is an element, ''false'' otherwise.
 
Returns ''true'' if the passed value is an element, ''false'' otherwise.
</section>
 
  
 
==Example==
 
==Example==

Revision as of 11:41, 25 June 2010

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

Click to collapse [-]
Server

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

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