GetResourceConfig - Revision history

Jaysds: /* Example */

2012-04-29T18:45:41Z

Example

← Older revision		Revision as of 18:45, 29 April 2012
Line 17:		Line 17:

	==Example==		==Example==
			<section name="Server" class="server" show="true">
	This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.		This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 22:		Line 23:
	local node = getResourceConfig( "config.xml" ) -- get the configuration file		local node = getResourceConfig( "config.xml" ) -- get the configuration file
	local subNode = xmlFindChild( node, "group", 0 ) -- get a subnode in it		local subNode = xmlFindChild( node, "group", 0 ) -- get a subnode in it
	outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox		outputChatBox( xmlNodeGetAttribute( subNode, "attr" ),root ) -- output its attributes value to chatbox
	end		end
	addEventHandler ( "onResourceStart", resourceRoot, resourceStart )		addEventHandler ( "onResourceStart", resourceRoot, resourceStart )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

JR10 at 16:29, 31 January 2012

2012-01-31T16:29:48Z

← Older revision		Revision as of 16:29, 31 January 2012
Line 19:		Line 19:
	This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.		This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function resourceStart ( ~~theResource~~ ) -- When a resource is started		function resourceStart ( ) -- When the resource is started
	~~if ( theResource == getThisResource () ) then -- and the resource is this one~~		local node = getResourceConfig( "config.xml" ) -- get the configuration file
	node = getResourceConfig( "~~:" .. getResourceName(theResource) .. "/~~config.xml" ) -- get the configuration file		local subNode = xmlFindChild( node, "group", 0 ) -- get a subnode in it
	local subNode = xmlFindChild( node, "group", 1 ) -- get a subnode in it		outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox
	outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox
	~~end~~
	end		end
	addEventHandler ( "onResourceStart", ~~getRootElement()~~, resourceStart )		addEventHandler ( "onResourceStart", resourceRoot, resourceStart )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}

The Kid: No longer needs checking.

2011-11-10T23:39:16Z

No longer needs checking.

← Older revision		Revision as of 23:39, 10 November 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{server client function}}		{{server client function}}
	~~{{Needs_Checking\|Example outdated. xmlFindSubNode no longer exists.}}~~
	This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[Meta.xml\|meta file]]. An alternative way to load XML files is to use [[xmlLoadFile]].		This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[Meta.xml\|meta file]]. An alternative way to load XML files is to use [[xmlLoadFile]].

Line 23:		Line 22:
	if ( theResource == getThisResource () ) then -- and the resource is this one		if ( theResource == getThisResource () ) then -- and the resource is this one
	node = getResourceConfig( ":" .. getResourceName(theResource) .. "/config.xml" ) -- get the configuration file		node = getResourceConfig( ":" .. getResourceName(theResource) .. "/config.xml" ) -- get the configuration file
	local subNode = ~~xmlFindSubNode~~( node, "group", 1 ) -- get a subnode in it		local subNode = xmlFindChild( node, "group", 1 ) -- get a subnode in it
	outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox		outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox
	end		end

Winky-: template article needs checking

2011-11-10T21:27:16Z

template article needs checking

← Older revision		Revision as of 21:27, 10 November 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{server client function}}		{{server client function}}
			{{Needs_Checking\|Example outdated. xmlFindSubNode no longer exists.}}
	This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[Meta.xml\|meta file]]. An alternative way to load XML files is to use [[xmlLoadFile]].		This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[Meta.xml\|meta file]]. An alternative way to load XML files is to use [[xmlLoadFile]].

Awwu: /* Required Arguments */

2009-09-16T16:55:52Z

Required Arguments

← Older revision		Revision as of 16:55, 16 September 2009
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''filePath:''' ~~the path~~ of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.		*'''filePath:''' The [[filepath]] of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
	:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''getResourceConfig(":ctf/settings.xml")''.		:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''getResourceConfig(":ctf/settings.xml")''.
	:If the file is in the current resource, only the file path is necessary, e.g. ''getResourceConfig("settings.xml")''.		:If the file is in the current resource, only the file path is necessary, e.g. ''getResourceConfig("settings.xml")''.

Erorr404: updated to new 1.0 syntax

2009-07-30T02:30:58Z

updated to new 1.0 syntax

← Older revision		Revision as of 02:30, 30 July 2009
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	xmlnode getResourceConfig ( ~~[resource theResource = getThisResource()],~~ string ~~filename~~ )		xmlnode getResourceConfig ( string filePath )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~filename~~:''' the ~~exact file name~~ of the ~~configuration~~ file~~. (e.g.~~ "~~file.xml~~" )		*'''filePath:''' the path of the file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file.
			:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''getResourceConfig(":ctf/settings.xml")''.
	~~===Optional Arguments===~~		:If the file is in the current resource, only the file path is necessary, e.g. ''getResourceConfig("settings.xml")''.
	*'''~~theResource:~~''' the resource to ~~retrieve~~ the ~~configuration~~ file from. ~~Note~~: the resource ~~has to be running~~, ~~otherwise this function will fail~~.

	===Returns===		===Returns===
Line 22:		Line 21:
	function resourceStart ( theResource ) -- When a resource is started		function resourceStart ( theResource ) -- When a resource is started
	if ( theResource == getThisResource () ) then -- and the resource is this one		if ( theResource == getThisResource () ) then -- and the resource is this one
	node = getResourceConfig( theResource, "config.xml" ) -- get the configuration file		node = getResourceConfig( ":" .. getResourceName(theResource) .. "/config.xml" ) -- get the configuration file
	local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it		local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it
	outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox		outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox

Arc at 21:11, 16 November 2008

2008-11-16T21:11:32Z

← Older revision		Revision as of 21:11, 16 November 2008
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''filename:''' ~~The~~ exact file name of the configuration file. (e.g. "file.xml" )		*'''filename:''' the exact file name of the configuration file. (e.g. "file.xml" )

	===Optional Arguments===		===Optional Arguments===
	*'''theResource:''' ~~The~~ resource from ~~which~~ the function ~~calls the configuration file~~		*'''theResource:''' the resource to retrieve the configuration file from. Note: the resource has to be running, otherwise this function will fail.

	===Returns===		===Returns===

Ransom: /* Example */

2008-04-09T10:51:50Z

Example

← Older revision		Revision as of 10:51, 9 April 2008
Line 24:		Line 24:
	node = getResourceConfig( theResource, "config.xml" ) -- get the configuration file		node = getResourceConfig( theResource, "config.xml" ) -- get the configuration file
	local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it		local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it
	outputChatBox( xmlNodeGetAttribute( ~~node~~, "attr" ) ) -- output its attributes value to chatbox		outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox
	end		end
	end		end

Awwu at 20:26, 28 March 2008

2008-03-28T20:26:41Z

← Older revision		Revision as of 20:26, 28 March 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{server client function}}		{{server client function}}
	This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[meta file]]. An alternative way to load XML files is to use [[xmlLoadFile]].		This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[Meta.xml\|meta file]]. An alternative way to load XML files is to use [[xmlLoadFile]].

	==Syntax==		==Syntax==
Line 32:		Line 32:
	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}
	~~[[Category:Incomplete]]~~

Erorr404: changed variable name to more accurate description

2008-01-06T03:40:00Z

changed variable name to more accurate description

← Older revision		Revision as of 03:40, 6 January 2008
Line 20:		Line 20:
	This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.		This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function resourceStart ( ~~resource~~ ) -- When a resource is started		function resourceStart ( theResource ) -- When a resource is started
	if ( ~~resource~~ == getThisResource () ) then -- and the resource is this one		if ( theResource == getThisResource () ) then -- and the resource is this one
	node = getResourceConfig( ~~resource~~, "config.xml" ) -- get the configuration file		node = getResourceConfig( theResource, "config.xml" ) -- get the configuration file
	local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it		local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it
	outputChatBox( xmlNodeGetAttribute( node, "attr" ) ) -- output its attributes value to chatbox		outputChatBox( xmlNodeGetAttribute( node, "attr" ) ) -- output its attributes value to chatbox