Difference between revisions of "XmlLoadFile"

From Multi Theft Auto: Wiki
m
Line 11: Line 11:
 
===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 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")''.
+
:For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: ''xmlLoadFile(":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. ''xmlLoadFile("settings.xml")''.
  
 
===Returns===
 
===Returns===

Revision as of 03:20, 30 July 2009

This function provides an alternative way to load XML files to getResourceConfig. This function loads an XML file and returns the node by specifying a specific file path, while getResourceConfig allows for loading an XML file from a resource.

Syntax

xmlnode xmlLoadFile ( string filePath )

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.
For example, if there is a file named 'settings.xml' in the resource 'ctf', it can be accessed from another resource this way: xmlLoadFile(":ctf/settings.xml").
If the file is in the current resource, only the file path is necessary, e.g. xmlLoadFile("settings.xml").

Returns

Returns the root xmlnode object of an xml file if successful, or false otherwise.

Example

This example loads an XML file called settings.xml that is in a resource called ctv.

node = xmlLoadFile ( ":ctv/settings.xml" )

See Also

BETA: FROM VERSION 1.5.7 r19626 ONWARDS