XmlFindSubNode: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
{{Deprecated|xmlFindChild}}
This function returns a named sub node of a particular XML node.
This function returns a named sub node of a particular XML node.


Line 6: Line 8:
<syntaxhighlight lang="lua">xmlnode xmlFindSubNode ( xmlnode parent, string subnode, int index )</syntaxhighlight>
<syntaxhighlight lang="lua">xmlnode xmlFindSubNode ( xmlnode parent, string subnode, int index )</syntaxhighlight>


===Required Arguments===  
===Required Arguments===
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
* '''parent''': This is an [[xmlnode]] that you want to find the subnode under. This could be a node returned from another call to [[xmlFindSubNode]].
*'''argumentName:''' description
* '''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.
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
Returns a table of resources.
Returns an [[xmlnode]] object if the node was found, ''false'' otherwise.


==Example==
==Example==
This function lists all loaded resources in the console.
<section name="Server" class="server" show="true">
If you wanted to find the 'instructions' node in a map file like this:
<syntaxhighlight lang="xml">
<map version="2.0">
      <options>
            <instructions>Start at the begining and keep going until the end!</instructions>
      </options>
</map>
</syntaxhighlight>
 
You could use the following code:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function blabla ()
maproot = getLoadedMapXMLRoot ()
    --this does blabla
optionsnode = xmlFindSubNode ( maproot, "options", 0 )
end
instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 )
</syntaxhighlight>
</syntaxhighlight>
 
</section>


==See Also==
==See Also==
{{XML functions}}
{{XML functions}}

Latest revision as of 16:14, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use xmlFindChild instead.


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


Retrieved from "https://wiki.multitheftauto.com/wiki/XmlFindSubNode?oldid=44558"