XmlFindSubNode

From Multi Theft Auto: Wiki
Revision as of 21:41, 20 April 2011 by Arran Fortuna (talk | contribs)
Jump to navigation Jump to search

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.


Please use xmlFindChild

This function returns a named sub node of a particular XML node.

Syntax

xmlnode xmlFindSubNode ( xmlnode parent, string subnode, int index )

Required Arguments

  • parent: This is an xmlnode that you want to find the subnode under. This could be a node returned from another call to xmlFindSubNode.
  • subnode: This is the name of the subnode you wish to find.
  • index: This is the index of the node you wish to find. For example, to find the 5th subnode with a particular name, you would use 4 as the index value. To find the first occurence, use 0.

Returns

Returns an xmlnode object if the node was found, false otherwise.

Example

Click to collapse [-]
Server

If you wanted to find the 'instructions' node in a map file like this:

<map version="2.0">
      <options>
            <instructions>Start at the begining and keep going until the end!</instructions>
      </options>
</map>

You could use the following code:

maproot = getLoadedMapXMLRoot ()
optionsnode = xmlFindSubNode ( maproot, "options", 0 )
instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 )

See Also