XmlFindSubNode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 14: Line 14:
==Example==
==Example==
If you wanted to find the 'instructions' node in a map file like this:
If you wanted to find the 'instructions' node in a map file like this:
<map>
<syntaxhighlight lang="xml">
      <options>
<map>
            <instructions>Start at the begining and keep going until the end!</instructions>
      <options>
      <options>
            <instructions>Start at the begining and keep going until the end!</instructions>
</map>
      <options>
</map>
</syntaxhighlight>
 
You could use the following code:
You could use the following code:
maproot = [[getLoadedMapXMLRoot]] ();
<syntaxhighlight lang="lua">
optionsnode = [[xmlFindSubNode]] ( maproot, "options", 0 );
maproot = [[getLoadedMapXMLRoot]] ();
instructionsnode = [[xmlFindSubNode]] ( optionsnode, "instructions", 0 );
optionsnode = [[xmlFindSubNode]] ( maproot, "options", 0 );
instructionsnode = [[xmlFindSubNode]] ( optionsnode, "instructions", 0 );
</syntaxhighlight>

Revision as of 19:04, 18 May 2006

Description

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.

Example

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

<map>
      <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 );