XmlNodeGetAttribute: Difference between revisions
Jump to navigation
Jump to search
Black Dragon (talk | contribs) mNo edit summary |
(Fix oop syntax) |
||
| (9 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | |||
This function is used to return an attribute of a node in a configuration file. | This function is used to return an attribute of a node in a configuration file. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string xmlNodeGetAttribute ( xmlnode | string xmlNodeGetAttribute ( xmlnode node, string name ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[xmlnode]]:getAttribute||xmlNodeSetAttribute}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''node:''' The node from which you wish to return the attribute | ||
*'''name:''' The name of the attribute. | *'''name:''' The name of the attribute. | ||
===Returns=== | ===Returns=== | ||
Returns the attribute in string form. | Returns the attribute in string form or ''false'', if the attribute is not defined. | ||
==Example== | ==Example== | ||
Suppose we have a gametype where only one type of car is used, and this type should not depend on the map but rather be set in an external configuration file and be used in all maps. Here's an example where the configuration file is an XML document: | |||
settings.xml | |||
<syntaxhighlight lang="xml"> | |||
<car model="528" posX="123.4" posY="456.7" posZ="12.3" rot="90.0" /> | |||
</syntaxhighlight> | |||
Lua code | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | local xml = getResourceConfig("settings.xml") -- load XML file and get its root element | ||
local carmodel = xmlNodeGetAttribute(xml, "model") -- get attribute of root element | |||
local carX = xmlNodeGetAttribute(xml, "posX") | |||
local carY = xmlNodeGetAttribute(xml, "posY") | |||
local carZ = xmlNodeGetAttribute(xml, "posZ") | |||
local carA = xmlNodeGetAttribute(xml, "rot") | |||
createVehicle(carmodel, tonumber(carX), tonumber(carY), tonumber(carZ), 0.0, 0.0, tonumber(carA)) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{XML_functions}} | {{XML_functions}} | ||
[[ | [[ru:xmlNodeGetAttribute]] | ||
Latest revision as of 14:50, 6 August 2016
This function is used to return an attribute of a node in a configuration file.
Syntax
string xmlNodeGetAttribute ( xmlnode node, string name )
OOP Syntax Help! I don't understand this!
- Method: xmlnode:getAttribute(...)
- Counterpart: xmlNodeSetAttribute
Required Arguments
- node: The node from which you wish to return the attribute
- name: The name of the attribute.
Returns
Returns the attribute in string form or false, if the attribute is not defined.
Example
Suppose we have a gametype where only one type of car is used, and this type should not depend on the map but rather be set in an external configuration file and be used in all maps. Here's an example where the configuration file is an XML document:
settings.xml
<car model="528" posX="123.4" posY="456.7" posZ="12.3" rot="90.0" />
Lua code
local xml = getResourceConfig("settings.xml") -- load XML file and get its root element
local carmodel = xmlNodeGetAttribute(xml, "model") -- get attribute of root element
local carX = xmlNodeGetAttribute(xml, "posX")
local carY = xmlNodeGetAttribute(xml, "posY")
local carZ = xmlNodeGetAttribute(xml, "posZ")
local carA = xmlNodeGetAttribute(xml, "rot")
createVehicle(carmodel, tonumber(carX), tonumber(carY), tonumber(carZ), 0.0, 0.0, tonumber(carA))