StartResource: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server function}}
{{Server function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
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.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool startResource ( resource, [bool persistent = false] )
bool startResource ( resource resourceToStart, [bool persistent = false] )
</syntaxhighlight>  
</syntaxhighlight>  


===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 -->
*'''resourceToStart:''' The resource that should be started.
*'''resource:''' The resource that should be started.


<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===  
===Optional Arguments===  
{{OptionalArg}}  
{{OptionalArg}}  
Line 20: Line 16:


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if the resource has been started succesfully, ''false'' otherwise.
Returns ''true'' if the resource has been started succesfully, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This page does not have an example
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
 
--add an example here.
</syntaxhighlight>
</syntaxhighlight>


==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 -->
{{Resource_functions}}
{{Resource_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function
[[Category:Needs_Example]]

Revision as of 15:36, 29 August 2007

This function starts a resource either persistently or as a dependency of the current resource.

Syntax

bool startResource ( resource resourceToStart, [bool persistent = false] )

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.

  • persistant: 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.

Returns

Returns true if the resource has been started succesfully, false otherwise.

Example

This page does not have an example 

--add an example here.

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/StartResource?oldid=11565"