AddResourceConfig: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
xmlnode addResourceConfig ( resource theResource, string filename, [ string filetype = "server" ] )
xmlnode addResourceConfig ( string filePath, [ string filetype = "server" ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''theResource:''' the [[resource]] to which the config file will be added.
*'''filePath:''' The [[filepath]] of the file to be created 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.
*'''filename:''' the name of the config file to be added.
:For example, if you want to create a config named 'settings.xml' in the resource 'ctf', it can be created from another resource this way: ''addResourceConfig(":ctf/settings.xml", "server")''.
:If you want to create the file in the current resource, only the file path is necessary, e.g. ''addResourceConfig("settings.xml", "server")''.


===Optional Arguments===  
===Optional Arguments===  
Line 20: Line 21:


==Example==
==Example==
[[Category:Needs Example]]
 
<section name="Server Example" class="server" show="true"><syntaxhighlight lang="lua">
function onStart()
  addResourceConfig(":ctf/settings.xml", "server")
end
addEventHandler("onResourceStart",getResourceRootElement(),onStart)
</syntaxhighlight></section>


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

Latest revision as of 16:42, 11 February 2015

This function adds a new empty config file to an existing resource.

Syntax

xmlnode addResourceConfig ( string filePath, [ string filetype = "server" ] )

Required Arguments

  • filePath: The filepath of the file to be created 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 you want to create a config named 'settings.xml' in the resource 'ctf', it can be created from another resource this way: addResourceConfig(":ctf/settings.xml", "server").
If you want to create the file in the current resource, only the file path is necessary, e.g. addResourceConfig("settings.xml", "server").

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • filetype: a string indicating whether the file is serverside ("server") or clientside ("client").

Returns

Returns the new config's root xmlnode if the config was added successfully, false otherwise.

Example

Click to collapse [-]
Server Example
function onStart()
   addResourceConfig(":ctf/settings.xml", "server")
end
addEventHandler("onResourceStart",getResourceRootElement(),onStart)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/AddResourceConfig?oldid=44520"