GetResourceConfig: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Black Dragon (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This function is used to return the root node of a configuration file. (defined in meta.xml) | ||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 11: | ||
===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 --> | <!-- 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 --> | ||
*''' | *'''theResource:''' The resource from which the function calls the configuration file | ||
*'''filename:''' The exact file name of the configuration file. (e.g. "file.xml" ) | |||
*''' | |||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ' | Returns the root node of the specified configuration file. If the file is corrupted, not defined in meta.xml or doesn't exist, returns false. | ||
==Example== | ==Example== | ||
==See Also== | ==See Also== | ||
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc --> | ||
{{FunctionArea_functions}} | {{FunctionArea_functions}} | ||
[[Category:Incomplete]] | [[Category:Incomplete]] | ||
Revision as of 09:07, 14 June 2007
This function is used to return the root node of a configuration file. (defined in meta.xml)
Syntax
xmlnode getResourceConfig ( resource theResource, string filename )
Required Arguments
- theResource: The resource from which the function calls the configuration file
- filename: The exact file name of the configuration file. (e.g. "file.xml" )
Returns
Returns the root node of the specified configuration file. If the file is corrupted, not defined in meta.xml or doesn't exist, returns false.