XmlFindSubNode: 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">xmlnode xmlFindSubNode ( xmlnode parent, string subnode, int index )</syntaxhighlight>
<syntaxhighlight lang="xml">xmlnode xmlFindSubNode ( xmlnode parent, string subnode, int index )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
Line 24: Line 24:


You could use the following code:
You could use the following code:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="xml">
maproot = getLoadedMapXMLRoot ();
maproot = getLoadedMapXMLRoot ();
optionsnode = xmlFindSubNode ( maproot, "options", 0 );
optionsnode = xmlFindSubNode ( maproot, "options", 0 );

Revision as of 22:45, 20 May 2006

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

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

Note: You could use getMapOption to do the same thing.

See Also