StopResource - Revision history

FileEX: /* See Also */

2024-09-06T22:49:25Z

2019-08-11T04:47:04Z

← Older revision		Revision as of 04:47, 11 August 2019
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	This function stops a running resource.<br>		This function stops a running resource.<br>
	~~'''~~Note~~:'''~~ This function does not stop the resource immediately, so don't expect that it starts stopping until the [[onResourceStop]] event for that resource is triggered. This happens after the scripts are done executing for this server frame.		{{Note\| This function does not stop the resource immediately, so don't expect that it starts stopping until the [[onResourceStop]] event for that resource is triggered. This happens after the scripts are done executing for this server frame.}}

	==Syntax==		==Syntax==

2015-01-01T16:26:12Z

add oop syntax

← Older revision		Revision as of 16:26, 1 January 2015
Line 8:		Line 8:
	bool stopResource ( resource theResource )		bool stopResource ( resource theResource )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[resource]]:stop}}
	===Required Arguments===		===Required Arguments===
	*'''theResource:''' the [[resource]] that should be stopped.		*'''theResource:''' the [[resource]] that should be stopped.

2010-04-12T15:32:32Z

← Older revision		Revision as of 15:32, 12 April 2010
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	This function stops a running resource.<br>		This function stops a running resource.<br>
	'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until the [[onResourceStop]] event for that resource is ~~called~~. This happens after the scripts are done executing for this server frame.		'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until the [[onResourceStop]] event for that resource is triggered. This happens after the scripts are done executing for this server frame.

	==Syntax==		==Syntax==

2008-01-05T03:29:53Z

← Older revision		Revision as of 03:29, 5 January 2008
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	This function stops a running resource.<br>		This function stops a running resource.<br>
	'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until onResourceStop for that resource is called. This happens after the scripts are done executing for this server frame.		'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until the [[onResourceStop]] event for that resource is called. This happens after the scripts are done executing for this server frame.

	==Syntax==		==Syntax==

2008-01-05T03:28:16Z

← Older revision		Revision as of 03:28, 5 January 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	This function stops a running resource.		This function stops a running resource.<br>
	'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until onResourceStop for that resource is called. This happens after the scripts are done executing for this server frame.		'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until onResourceStop for that resource is called. This happens after the scripts are done executing for this server frame.

2008-01-05T03:28:07Z

← Older revision		Revision as of 03:28, 5 January 2008
Line 2:		Line 2:
	{{Server function}}		{{Server function}}
	This function stops a running resource.		This function stops a running resource.
			'''Note:''' This function does not stop the resource immediately, so don't expect that it starts stopping until onResourceStop for that resource is called. This happens after the scripts are done executing for this server frame.

	==Syntax==		==Syntax==

2007-08-29T15:44:33Z

corrected example, cleaned up slightly.

← Older revision		Revision as of 15:44, 29 August 2007
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''theResource:''' the [[resource]] ~~we want to stop~~.		*'''theResource:''' the [[resource]] that should be stopped.

	===Returns===		===Returns===
Line 15:		Line 15:

	==Example==		==Example==
	This function stops all running resources.		This function stops all running resources except the current one.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function stopAllResources()		function stopAllResources()
Line 21:		Line 21:
	local allResources = getResources()		local allResources = getResources()
	-- for each one of them,		-- for each one of them,
	for i, ~~res~~ in ipairs(allResources) do		for i, resource in ipairs(allResources) do
	-- if it's running,		-- if it's running, and it is not the current resource
	if getResourceState(resource) == "running" then		if ( getResourceState(resource) == "running" ) and ( resource ~= getThisResource() ) then
	-- then stop it		-- then stop it
	stopResource(~~res~~)		stopResource(resource)
	end		end
	end		end

2007-08-15T18:53:48Z

← Older revision		Revision as of 18:53, 15 August 2007
Line 18:		Line 18:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function stopAllResources()		function stopAllResources()
	-- we store a table of resources		-- we store a table of resources
	local allResources = getResources()		local allResources = getResources()
	-- for each one of them,		-- for each one of them,
	for ~~index~~, ~~resource~~ in ipairs(allResources) do		for i, res in ipairs(allResources) do
	-- if it's running,		-- if it's running,
	if getResourceState(resource) == "running" then		if getResourceState(resource) == "running" then
	-- then stop it		-- then stop it
	stopResource(~~resource~~)		stopResource(res)
	end		end
	end		end
	end		end
	</syntaxhighlight>		</syntaxhighlight>

2007-08-15T18:41:34Z

← Older revision		Revision as of 18:41, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server function}}
	This function stops a running resource.		This function stops a running resource.

Line 17:		Line 18:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function stopAllResources()		function stopAllResources()
	--we store a table of resources		-- we store a table of resources
	local allResources = getResources()		local allResources = getResources()
	--for each one of them,		-- for each one of them,
	for index, resource in ipairs(allResources) do		for index, resource in ipairs(allResources) do
	--if it's running,		-- if it's running,
	if getResourceState(resource) == "running" then		if getResourceState(resource) == "running" then
	--then stop it		-- then stop it
	stopResource(resource)		stopResource(resource)
	end		end