GetElementID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (→‎Syntax: OOP)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getElementID ( element theElement )  
string getElementID ( element theElement )  
</syntaxhighlight>  
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Element class.|[[element]]:getID|id|}}


===Required Arguments===  
===Required Arguments===  

Revision as of 16:19, 16 August 2014

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!

Note: This function is also a static function underneath the Element class.
Method: element:getID(...)
Variable: .id


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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementID?oldid=41451"