IsElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 3: Line 3:


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool isElement ( var )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isElement ( var theValue )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
* '''var''': A value that may or may not be an element.
* '''theValue''': The value that we want to check.


===Returns===
===Returns===
Line 12: Line 12:


==Example==
==Example==
This example checks if the  
This function kills a player when it's passed the player element, or his name.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--we create a variable
function killPlayer2 ( argument )
local var
-- if the argument is an element, and also a player,
--we randomise its value
if isElement( argument ) and getElementType( argument, "player" ) then
if math.random(0,1) == 1 then var = getRootElement()
-- kill him
else var = "string"
killPlayer ( argument )
end
 
--and then we can check if it's an element or not
-- if it isn't an element, but a string, it could be a name
if isElement(var) then outputChatBox("math.random generated number 1")
elseif type ( argument ) == "string" then
else then outputChatBox("math.random generated number 0")
-- 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
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 15:28, 29 July 2007

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


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElement?oldid=9315"