GetElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">string getElementData ( element theElement, string name )</syntaxhighlight>
<syntaxhighlight lang="lua">var getElementData ( element theElement, string name )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
Line 10: Line 10:


===Returns===
===Returns===
This function returns a ''string'' containing the requested element data, or ''false'' if the element data does not exist, or the element itself does not exist.
This function returns a ''variable'' containing the requested element data, or ''false'' if the element data does not exist, or the element itself does not exist. Usually this is a ''string'' but it doesn't have to be.


==Example==
==Example==

Revision as of 17:48, 21 August 2006

Elements can contain data values. These are accessable via names, and their value can be retrieved using getElementData and set using setElementData. These values are also loaded from the attributes in the XML map files, and as such can provide a powerful way to store and retrieve data in XML for each element.

Syntax

var getElementData ( element theElement, string name )

Required Arguments

  • theElement: This is the element with data you want to retreive.
  • name: The name of the element data entry you want to retrieve.

Returns

This function returns a variable containing the requested element data, or false if the element data does not exist, or the element itself does not exist. Usually this is a string but it doesn't have to be.

Example

This example will store the version of the map in the variable mapVersion. Generally this will be 2.0 in the final release. 

map = getRootElement ( )
mapVersion = getElementData ( map, "version" )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementData?oldid=4506"