GetElementType: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (fixed a mistake) |
||
(14 intermediate revisions by 13 users not shown) | |||
Line 1: | Line 1: | ||
{{Server client function}} | |||
__NOTOC__ | |||
__NOTOC__ | This function is used to retrieve the type of an element. | ||
This | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string getElementType ( element | string getElementType ( element theElement ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[element]]:getType|type|}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theElement:''' The [[element]] you wish to get the type of. | ||
===Returns=== | ===Returns=== | ||
Returns '' | Returns a ''string'' containing the element type, ''false'' if invalid arguments were passed. | ||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | |||
This example destroys a haystack when a player targets it | This example destroys a haystack when a player targets it | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onPlayerTarget ( targetElem ) | |||
-- if the targeted object is a haystack (an object with model ID 3374) remove it from the game | |||
if | if getElementType ( targetElem ) == "object" and getElementModel ( targetElem ) == 3374 then | ||
destroyElement ( | destroyElement ( targetElem ) | ||
end | end | ||
end | end | ||
addEventHandler ( "onPlayerTarget", root, onPlayerTarget ) -- add above function as handler for targeting event | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
==See Also== | ==See Also== | ||
{{Element functions}} | |||
[[pt-br:getElementType]] |
Latest revision as of 14:25, 27 April 2021
This function is used to retrieve the type of an element.
Syntax
string getElementType ( element theElement )
OOP Syntax Help! I don't understand this!
- Method: element:getType(...)
- Variable: .type
Required Arguments
- theElement: The element you wish to get the type of.
Returns
Returns a string containing the element type, false if invalid arguments were passed.
Example
Click to collapse [-]
ServerThis example destroys a haystack when a player targets it
function onPlayerTarget ( targetElem ) -- if the targeted object is a haystack (an object with model ID 3374) remove it from the game if getElementType ( targetElem ) == "object" and getElementModel ( targetElem ) == 3374 then destroyElement ( targetElem ) end end addEventHandler ( "onPlayerTarget", root, onPlayerTarget ) -- add above function as handler for targeting event
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