IsElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
This function checks if a value is an [[element]] or not.
This function checks if a value is an [[element]] or not.
{{Note|This function is not reliable as element ids are eventually recycled. Always make sure you nil variables containing an element after calling [[destroyElement]]}}
{{Note|This function is not reliable as element ids are eventually recycled. Always make sure you nil variables containing an element after calling [[destroyElement]] or handle [[onElementDestroy]] for players and elements that might be destroyed by another resource}}
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool isElement ( var theValue )</syntaxhighlight>
<syntaxhighlight lang="lua">bool isElement ( var theValue )</syntaxhighlight>

Revision as of 11:12, 5 November 2013

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

[[{{{image}}}|link=|]] Note: This function is not reliable as element ids are eventually recycled. Always make sure you nil variables containing an element after calling destroyElement or handle onElementDestroy for players and elements that might be destroyed by another resource

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
		killPed ( 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 = getPlayerFromName( argument )
		-- if a player with such a name exists,
		if playerElement then
			-- kill him
			killPed ( playerElement )
		end
	end
end

See Also