GetElementID: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
==Example== | ==Example== | ||
To get the ID of the following element: | To get the ID of the following element: | ||
<syntaxhighlight lang="xml"><flag id="northflag" posX="2365" posY="215" posZ="32"></syntaxhighlight> | <syntaxhighlight lang="xml"><flag id="northflag" posX="2365" posY="215" posZ="32" /></syntaxhighlight> | ||
You could use the following code: | You could use the following code: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- assume flag refers to the flag element in the above XML code | -- assume flag refers to the flag element in the above XML code | ||
idstring = getElementID ( flag ) -- get the id of the flag element | idstring = getElementID ( flag ) -- get the id of the flag element | ||
outputChatBox ( "The flag's ID is: " .. idstring ) -- output: The flag's ID is: northflag | outputChatBox ( "The flag's ID is: " .. idstring ) -- output: The flag's ID is: northflag | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 19:59, 19 August 2007
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 )
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