IsElement: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server client function}} | |||
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]] or handle [[onElementDestroy]] for players and elements that might be destroyed by another resource}} | |||
==Syntax== | |||
<syntaxhighlight lang="lua">bool isElement ( var theValue )</syntaxhighlight> | |||
===Required Arguments=== | |||
* '''theValue''': The value that we want to check. | |||
===Returns=== | |||
Returns ''true'' if the passed value is an element, ''false'' otherwise. | |||
==Example== | |||
<section name="Server" class="server" show="true"> | |||
This serverside function kills a player when it's passed his name or his element. | |||
<syntaxhighlight lang="lua"> | |||
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 | |||
</syntaxhighlight> | |||
</section> | |||
==See Also== | |||
{{Element functions}} |
Latest revision as of 18:38, 1 January 2017
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 [-]
ServerThis 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
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByIndex
- getElementByID
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementColShape
- getElementData
- getAllElementData
- hasElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getElementType
- getElementVelocity
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementWithinColShape
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getPedContactElement
- getResourceDynamicElementRoot
- getResourceRootElement