GetResourceConfig: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
No edit summary |
||
Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''filename:''' | *'''filename:''' the exact file name of the configuration file. (e.g. "file.xml" ) | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
*'''theResource:''' | *'''theResource:''' the resource to retrieve the configuration file from. Note: the resource has to be running, otherwise this function will fail. | ||
===Returns=== | ===Returns=== |
Revision as of 21:11, 16 November 2008
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.
Syntax
xmlnode getResourceConfig ( [resource theResource = getThisResource()], string filename )
Required Arguments
- filename: the exact file name of the configuration file. (e.g. "file.xml" )
Optional Arguments
- theResource: the resource to retrieve the configuration file from. Note: the resource has to be running, otherwise this function will fail.
Returns
Returns the root node of the specified configuration file. If the file is corrupted, not defined in the meta file or doesn't exist, returns false.
Example
This example opens a configuration file and prints the value of the 'attr' attribute of the first 'group' node.
function resourceStart ( theResource ) -- When a resource is started if ( theResource == getThisResource () ) then -- and the resource is this one node = getResourceConfig( theResource, "config.xml" ) -- get the configuration file local subNode = xmlFindSubNode( node, "group", 1 ) -- get a subnode in it outputChatBox( xmlNodeGetAttribute( subNode, "attr" ) ) -- output its attributes value to chatbox end end addEventHandler ( "onResourceStart", getRootElement(), resourceStart )
See Also
- abortRemoteRequest
- call
- fetchRemote
- getResourceConfig
- getResourceDynamicElementRoot
- getResourceExportedFunctions
- getResourceFromName
- getResourceName
- getResourceRootElement
- getResourceState
- getThisResource
- getRemoteRequests
- getRemoteRequestInfo