XmlFindSubNode - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:14:06Z

Changed "DeprecatedWithAlt" template to "Deprecated"

← Older revision		Revision as of 16:14, 13 February 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{~~DeprecatedWithAlt~~\|xmlFindChild\|}}		{{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.

Winky- at 21:24, 10 November 2011

2011-11-10T21:24:25Z

← Older revision		Revision as of 21:24, 10 November 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	{{~~Deprecated~~}}		{{DeprecatedWithAlt\|xmlFindChild\|}}

	~~Please use [[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.

Arran Fortuna at 21:41, 20 April 2011

2011-04-20T21:41:42Z

← Older revision		Revision as of 21:41, 20 April 2011
Line 2:		Line 2:
	{{Server client function}}		{{Server client function}}
	{{Deprecated}}		{{Deprecated}}

			Please use [[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.

Ccw at 14:24, 20 January 2009

2009-01-20T14:24:33Z

← Older revision		Revision as of 14:24, 20 January 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
			{{Deprecated}}
	This function returns a named sub node of a particular XML node.		This function returns a named sub node of a particular XML node.

EAi: /* Example */

2008-10-01T11:10:52Z

Example

← Older revision		Revision as of 11:10, 1 October 2008
Line 31:		Line 31:
	instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 )		instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 )
	</syntaxhighlight>		</syntaxhighlight>

	~~Note: You could use [[getMapOption]] to do the same thing.~~
	</section>		</section>

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

Stevvo: Removed semicolons from example, it isn't normal to use semicolons in lua?

2008-04-27T19:23:07Z

Removed semicolons from example, it isn't normal to use semicolons in lua?

← Older revision		Revision as of 19:23, 27 April 2008
Line 27:		Line 27:
	You could use the following code:		You could use the following code:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	maproot = getLoadedMapXMLRoot ();		maproot = getLoadedMapXMLRoot ()
	optionsnode = xmlFindSubNode ( maproot, "options", 0 );		optionsnode = xmlFindSubNode ( maproot, "options", 0 )
	instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 );		instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 )
	</syntaxhighlight>		</syntaxhighlight>

JHXP: reverted edits by jhxp to last version by Arc_ (oops :p)

2007-10-19T16:49:19Z

reverted edits by jhxp to last version by Arc_ (oops :p)

← Older revision		Revision as of 16:49, 19 October 2007
Line 6:		Line 6:
	<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>

			Note: You could use [[getMapOption]] to do the same thing.
			</section>

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

JHXP at 16:48, 19 October 2007

2007-10-19T16:48:12Z

← Older revision		Revision as of 16:48, 19 October 2007
Line 6:		Line 6:
	<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===
	* '''~~parent~~'''~~: This is an [[xmlnode]] that you want to find the subnode under. This could be a node returned from another call to [[xmlFindSubNode]].~~		<!-- 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 -->
	* '''~~subnode~~'''~~: This is the name of the subnode you wish to find.~~		*'''argumentName:''' description
	* '''~~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 ~~an [[xmlnode]] object if the node was found, ''false'' otherwise~~.		Returns a table of resources.

	==Example==		==Example==
	~~<section name="Server" class="server" show="true">~~		This function lists all loaded resources in the console.
	~~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">
	~~maproot = getLoadedMapXMLRoot~~ ();		function blabla ()
	~~optionsnode = xmlFindSubNode ( maproot, "options", 0 );~~		--this does blabla
	~~instructionsnode = xmlFindSubNode ( optionsnode, "instructions", 0 );~~		end
	</syntaxhighlight>		</syntaxhighlight>

	~~Note: You could use [[getMapOption]] to do the same thing.~~
	~~</section>~~

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

Arc at 15:03, 21 August 2007

2007-08-21T15:03:35Z

← Older revision		Revision as of 15:03, 21 August 2007
Line 15:		Line 15:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	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:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
Line 32:		Line 33:

	Note: You could use [[getMapOption]] to do the same thing.		Note: You could use [[getMapOption]] to do the same thing.
			</section>

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

Arc at 15:53, 15 August 2007

2007-08-15T15:53:32Z

← Older revision		Revision as of 15:53, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function returns a named sub node of a particular XML node.		This function returns a named sub node of a particular XML node.