GetElementID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function gets the ID of an element. This is the element value of the item 'id', but NOT like a model ID, weapons ID or simliar.
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==  
==Syntax==  
Line 16: Line 16:
==Example==  
==Example==  
To get the ID of the following element:
To get the ID of the following element:
<syntaxhighlight lang="lua"><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">

Revision as of 14:59, 15 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 retrive 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