GetElementID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server client 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.
{{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===  
*'''theElement:''' the element from which to retrive the ID.
*'''theElement:''' the element from which to retrieve the ID.


===Returns===
===Returns===
Line 16: Line 18:
==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">
-- 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>
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.

[[{{{image}}}|link=|]] Note: This function can also be used to get the resource name of any resource-data.

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

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