Difference between revisions of "StopResource"

From Multi Theft Auto: Wiki
Jump to: navigation, search
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+
This function stops a running resource.
This fake function is for use with blah & blah and does blahblahblabhalbhl
 
  
 
==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 stopResource ( resource )
+
bool stopResource ( resource theResource )
 
</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 -->
+
*'''theResource:''' the [[resource]] we want to stop.
*'''argumentName:''' description
 
 
 
<!-- Only include this section below if there are optional arguments -->
 
===Optional Arguments===
 
{{OptionalArg}}
 
*'''argumentName2:''' description
 
*'''argumentName3:''' description
 
  
 
===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 was stopped, ''false'' if the stopping failed, or an invalid resource was passed.
Returns ''true'' if blah, ''false'' otherwise.
 
  
 
==Example==  
 
==Example==  
<!-- Explain what the example is in a single sentance -->
+
This function stops all running resources.
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">
--This line does...
+
function stopAllResources()
blabhalbalhb --abababa
+
--we store a table of resources
--This line does this...
+
local allResources = getResources()
mooo
+
--for each one of them,
 +
for index, resource in allResources do
 +
--if it's running,
 +
if getResourceState(resource) == "running" then
 +
--then stop it
 +
stopResource(resource)
 +
end
 +
end
 +
end
 
</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}}
{{FunctionArea_functions}}
 
[[Category:Incomplete]] -- leave this unless you complete the function
 

Revision as of 11:41, 22 April 2007

This function stops a running resource.

Syntax

bool stopResource ( resource theResource )

Required Arguments

  • theResource: the resource we want to stop.

Returns

Returns true if the resource was stopped, false if the stopping failed, or an invalid resource was passed.

Example

This function stops all running resources.

function stopAllResources()
	--we store a table of resources
	local allResources = getResources()
	--for each one of them,
	for index, resource in allResources do
		--if it's running,
		if getResourceState(resource) == "running" then
			--then stop it
			stopResource(resource)
		end
	end
end

See Also