RestartResource: Difference between revisions

Latest revision as of 22:48, 6 September 2024

This function restarts a running resource. Restarting will destroy all the elements that the resource has created (as stopping the resource does).

Note:

Don't forget to give admin rights to the resource, in which you are using restartResource function or it won't work.
This function does not restart the resource immediately. Restarts are queued up until the end of the server's frame to ensure that they occur in the correct order (and that dependent resources can start and stop correctly). The resource being restarted will have an onResourceStop event triggered and the restarted instance will receive an onResourceStart event. Remember that the element and resource variables will be invalidated during the restart, though of course, the resource's name will not.

Syntax

bool restartResource ( resource theResource [, bool persistent = false, bool configs = true, bool maps = true, bool scripts = true, bool html = true, bool clientConfigs = true, bool clientScripts = true, bool clientFiles = true ] )

OOP Syntax Help! I don't understand this!

Method: resource:restart(...)

Required Arguments

theResource: the resource you want to restart.

Optional Arguments

persistent: Unused
configs: Reload configs?
maps: Reload maps?
scripts: Reload (server) scripts?
html: Reload html files (for resource web access)?
clientConfigs: Reload client configs?
clientScripts: Reload client scripts?
clientFiles: Reload files?

Returns

Returns true if the resource was restarted, false if the resource wasn't running, or an invalid resource was passed.

Example

Example 1: This function restarts all running resources.

function restartAllResources()
	-- we store a table of resources
	local allResources = getResources()
	-- for each one of them,
	for index, res in ipairs(allResources) do
		-- if it's running,
		if getResourceState(res) == "running" then
			-- then restart it
			restartResource(res)
		end
	end
end

Example 2: This example will restart the specify resource every 3600000 milliseconds (hour).

setTimer(
    function()  
	--restarting this resource every hour
        restartResource(getThisResource())
    end,
3600000, 0)

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Server function}}
-This function restarts a resource.
+__NOTOC__
+This function restarts a running resource. Restarting will destroy all the elements that the resource has created (as stopping the resource does).
+{{Note|
+*Don't forget to give admin rights to the resource, in which you are using restartResource function or it won't work.
+*This function does not restart the resource immediately. Restarts are queued up until the end of the server's frame to ensure that they occur in the correct order (and that dependent resources can start and stop correctly). The resource being restarted will have an [[onResourceStop]] event triggered and the restarted instance will receive an [[onResourceStart]] event. Remember that the element and resource variables will be invalidated during the restart, though of course, the resource's name will not.}}
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool restartResource ( resource theResource )
+bool restartResource ( resource theResource [, bool persistent = false, bool configs = true, bool maps = true, bool scripts = true, bool html = true, bool clientConfigs = true, bool clientScripts = true, bool clientFiles = true ] )
 </syntaxhighlight>
+{{OOP||[[resource]]:restart}}
+===Required Arguments===
+*'''theResource:''' the [[resource]] you want to restart.
-===Required Arguments===
+===Optional Arguments===
-*'''theResource:''' the resource we want to restart.
+*'''persistent:''' Unused
+*'''configs:''' Reload configs?
+*'''maps:''' Reload maps?
+*'''scripts:''' Reload (server) scripts?
+*'''html:''' Reload html files (for resource web access)?
+*'''clientConfigs:''' Reload client configs?
+*'''clientScripts:''' Reload client scripts?
+*'''clientFiles:''' Reload files?
 ===Returns===
-Returns ''true'' if the resource was restarted, ''false'' if the restart failed, or an invalid resource was passed.
+Returns ''true'' if the resource was restarted, ''false'' if the resource wasn't running, or an invalid resource was passed.
 ==Example==
-This function restarts all running resources.
+Example 1: This function restarts all running resources.
 <syntaxhighlight lang="lua">
 function restartAllResources()
-	--we store a table of resources
+	-- we store a table of resources
 	local allResources = getResources()
-	--for each one of them,
+	-- for each one of them,
-	for index, resource in allResources do
+	for index, res in ipairs(allResources) do
-		--if it's running,
+		-- if it's running,
-		if getResourceState(resource) == "running" then
+		if getResourceState(res) == "running" then
-			--then restart it
+			-- then restart it
-			restartResource(resource)
+			restartResource(res)
 		end
 	end
 end
+</syntaxhighlight>
+Example 2: This example will restart the specify resource every 3600000 milliseconds (hour).
+<syntaxhighlight lang="lua">
+setTimer(
+    function()
+	--restarting this resource every hour
+        restartResource(getThisResource())
+    end,
+3600000, 0)
 </syntaxhighlight>
 ==See Also==
-{{Resource_functions}}
+{{Resource_functions|server}}