GetElementID: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
{{Server client function}} | {{Server client function}} | ||
This function gets the ID of an element. This is the "id" attribute of the element and is a string, NOT a number like a model ID, weapons ID or similar. | This function gets the ID of an element. This is the "id" attribute of the element and is a string, NOT a number like a model ID, weapons ID or similar. | ||
{{Note| This function can also be used to get the resource name of any ''resource-data''.}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string getElementID ( element theElement ) | string getElementID ( element theElement ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[element]]:getID|id|setElementID}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 26: | Line 28: | ||
==See Also== | ==See Also== | ||
{{Element_functions}} | {{Element_functions}} | ||
[[de:GetElementID]] | |||
Latest revision as of 22:07, 10 February 2024
This function gets the ID of an element. This is the "id" attribute of the element and is a string, NOT a number like a model ID, weapons ID or similar.
Syntax
string getElementID ( element theElement )
OOP Syntax Help! I don't understand this!
- Method: element:getID(...)
- Variable: .id
- Counterpart: setElementID
Required Arguments
- theElement: the element from which to retrieve the ID.
Returns
This returns a string containing the element ID. It will return an empty string if it has no ID. It will return false if the element is invalid.
Example
To get the ID of the following element:
<flag id="northflag" posX="2365" posY="215" posZ="32" />
You could use the following code:
-- assume flag refers to the flag element in the above XML code idstring = getElementID ( flag ) -- get the id of the flag element outputChatBox ( "The flag's ID is: " .. idstring ) -- output: The flag's ID is: northflag
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