StartResource: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function starts a resource either persistently or as a dependency of the current resource. | This function starts a resource either persistently or as a dependency of the current resource. If you start the resource persistently, the resource will run until stopped either using [[stopResource]] or by the server admin. A resource started as a dependency will stop when your resource stops, if no other resources have it as a depdendency. This is the same effect as using an ''include'' in your [[meta.xml]] file. | ||
The function also allows you to specify a number of boolean options. These allow you to disable the loading of various aspects of the resource. This is generally useful for editors rather than for actual gamemodes. It could also be used as a way to preview a resource before enabling the scripting aspects, though this could produce unreliable results. There is no way for a resource to tell if it is being run with any of these booleans set. | |||
==Syntax== | ==Syntax== | ||
| Line 14: | Line 16: | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*'''persistent:''' A boolean specifying if the resource should continue to run even after this resource has been stopped or not. If this is ''true'' then the resource will run until another resource or user terminates it or the server shuts down. | *'''persistent:''' A boolean specifying if the resource should continue to run even after this resource has been stopped or not. If this is ''true'' then the resource will run until another resource or user terminates it or the server shuts down. | ||
*'''loadServerConfigs:''' A boolean specifying if | *'''loadServerConfigs:''' A boolean specifying if server side config (XML) files should be loaded with the resource. | ||
*'''loadMaps:''' A boolean specifying if any .map files will be started with the resource. | *'''loadMaps:''' A boolean specifying if any .map files will be started with the resource. | ||
*'''loadServerScripts:''' A boolean specifying if | *'''loadServerScripts:''' A boolean specifying if server side script files should be started alongside the resource. | ||
*'''loadHTML:''' A boolean specifying if HTML | *'''loadHTML:''' A boolean specifying if HTML files should be started alongside the resource. | ||
*'''loadClientConfigs:''' A boolean specifying if client configs should be loaded alongside the resource. | *'''loadClientConfigs:''' A boolean specifying if client configs should be loaded alongside the resource. | ||
*'''loadClientScripts:''' A boolean specifying if client scripts should be loaded and started alongside the resource. | *'''loadClientScripts:''' A boolean specifying if client scripts should be loaded and started alongside the resource. | ||
| Line 23: | Line 25: | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if the resource has been started | Returns ''true'' if the resource has been started successfully, ''false'' otherwise. | ||
==Example== | ==Example== | ||
Revision as of 01:48, 15 November 2007
This function starts a resource either persistently or as a dependency of the current resource. If you start the resource persistently, the resource will run until stopped either using stopResource or by the server admin. A resource started as a dependency will stop when your resource stops, if no other resources have it as a depdendency. This is the same effect as using an include in your meta.xml file.
The function also allows you to specify a number of boolean options. These allow you to disable the loading of various aspects of the resource. This is generally useful for editors rather than for actual gamemodes. It could also be used as a way to preview a resource before enabling the scripting aspects, though this could produce unreliable results. There is no way for a resource to tell if it is being run with any of these booleans set.
Syntax
bool startResource ( resource resourceToStart, [bool persistent = false, bool loadServerConfigs = true, bool loadMaps = true, bool loadServerScripts = true, bool loadHTML = true, bool loadClientConfigs = true, bool loadClientScripts = true, bool loadFiles = true] )
Required Arguments
- resourceToStart: The resource that should be started.
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.
- persistent: A boolean specifying if the resource should continue to run even after this resource has been stopped or not. If this is true then the resource will run until another resource or user terminates it or the server shuts down.
- loadServerConfigs: A boolean specifying if server side config (XML) files should be loaded with the resource.
- loadMaps: A boolean specifying if any .map files will be started with the resource.
- loadServerScripts: A boolean specifying if server side script files should be started alongside the resource.
- loadHTML: A boolean specifying if HTML files should be started alongside the resource.
- loadClientConfigs: A boolean specifying if client configs should be loaded alongside the resource.
- loadClientScripts: A boolean specifying if client scripts should be loaded and started alongside the resource.
- loadFiles: A boolean specifying if client-side files should be loaded alongside the resource.
Returns
Returns true if the resource has been started successfully, false otherwise.
Example
This page does not have an example
--add an example here.