StartResource - Revision history

FileEX: /* See Also */

2024-09-06T22:49:16Z

Qaisjp: elaborate on persistent

2020-01-14T21:26:58Z

elaborate on persistent

← Older revision		Revision as of 21:26, 14 January 2020
Line 15:		Line 15:
	===Optional Arguments===		===Optional Arguments===
	{{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 the current 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. If this is ''false'' then ''resourceToStart'' will stop when ''thisResource'' stops.
	*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started.		*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started.
	*'''loadServerConfigs:''' A boolean specifying if server side config (XML) files should be loaded with the resource.		*'''loadServerConfigs:''' A boolean specifying if server side config (XML) files should be loaded with the resource.

Strix at 16:25, 1 January 2015

2015-01-01T16:25:56Z

← Older revision		Revision as of 16:25, 1 January 2015
Line 9:		Line 9:
	bool startResource ( resource resourceToStart, [bool persistent = false, bool startIncludedResources = true, bool loadServerConfigs = true, bool loadMaps = true, bool loadServerScripts = true, bool loadHTML = true, bool loadClientConfigs = true, bool loadClientScripts = true, bool loadFiles = true] )		bool startResource ( resource resourceToStart, [bool persistent = false, bool startIncludedResources = true, bool loadServerConfigs = true, bool loadMaps = true, bool loadServerScripts = true, bool loadHTML = true, bool loadClientConfigs = true, bool loadClientScripts = true, bool loadFiles = true] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[resource]]:start}}
	===Required Arguments===		===Required Arguments===
	*'''resourceToStart:''' The resource that should be started.		*'''resourceToStart:''' The resource that should be started.

Awwu: /* Example */

2010-02-22T19:57:00Z

Example

← Older revision		Revision as of 19:57, 22 February 2010
Line 31:		Line 31:
	This example starts a specified resource with the command; "/resource-start".		This example starts a specified resource with the command; "/resource-start".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function startTheResource ( thePlayer, command, ~~resource~~ )		function startTheResource ( thePlayer, command, resourceName )
	if ( ~~resource~~ ) then -- Check if they specified a resource name		if ( resourceName ) then -- Check if they specified a resource name
	resource = getResourceFromName ( ~~resource~~ ) -- Get the resource		local resource = getResourceFromName ( resourceName ) -- Get the resource

	local start = startResource ( resource ) -- Start the resource		local start = startResource ( resource ) -- Start the resource
	if ( start ) then -- If it was successfully started...		if ( start ) then -- If it was successfully started...
	outputChatBox ( ~~resource~~ .. " was started successfully.", thePlayer, 255, 0, 0 )		outputChatBox ( resourceName .. " was started successfully.", thePlayer, 255, 0, 0 )
	else -- If it wasn't successfully started...		else -- If it wasn't successfully started...
	outputChatBox ( "This resource doesn't exist.", thePlayer, 255, 0, 0 )		outputChatBox ( "This resource doesn't exist.", thePlayer, 255, 0, 0 )

Paul Cortez: This has more chance of actually working

2010-02-22T11:13:17Z

This has more chance of actually working

← Older revision		Revision as of 11:13, 22 February 2010
Line 33:		Line 33:
	function startTheResource ( thePlayer, command, resource )		function startTheResource ( thePlayer, command, resource )
	if ( resource ) then -- Check if they specified a resource name		if ( resource ) then -- Check if they specified a resource name
	~~local~~ resource = ~~tostring~~ ( resource ) -- ~~This prevents "a userdata value" error~~		resource = getResourceFromName ( resource ) -- Get the resource

	local start = startResource ( resource ) -- Start the resource		local start = startResource ( resource ) -- Start the resource
	if ( start ) then -- If it was successfully started...		if ( start ) then -- If it was successfully started...
	outputChatBox ( resource .. " was started successfully.", thePlayer, 255, 0, 0 )		outputChatBox ( resource .. " was started successfully.", thePlayer, 255, 0, 0 )
	else -- If it wasn't successfully started...		else -- If it wasn't successfully started...
	outputChatBox ( "~~An unexpected error occured~~.", thePlayer, 255, 0, 0 )		outputChatBox ( "This resource doesn't exist.", thePlayer, 255, 0, 0 )
	end		end
	else -- If they didn't put a resource name...		else -- If they didn't put a resource name...
	outputChatBox ( "Please specify a resource to start.", thePlayer, 255, 0, 0 )		outputChatBox ( "Please specify a resource to start.", thePlayer, 255, 0, 0 )

Ca11um: Removed from "Needs example".

2010-02-22T07:26:27Z

Removed from "Needs example".

← Older revision		Revision as of 07:26, 22 February 2010
Line 49:		Line 49:
	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions}}
	~~[[Category:Needs_Example]]~~

Ca11um: Added an example.

2010-02-22T07:25:35Z

Added an example.

← Older revision		Revision as of 07:25, 22 February 2010
Line 29:		Line 29:

	==Example==		==Example==
	This ~~page does not have an~~ example		This example starts a specified resource with the command; "/resource-start".
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~add an example here~~.		function startTheResource ( thePlayer, command, resource )
			if ( resource ) then -- Check if they specified a resource name
			local resource = tostring ( resource ) -- This prevents "a userdata value" error
			local start = startResource ( resource ) -- Start the resource
			if ( start ) then -- If it was successfully started...
			outputChatBox ( resource .. " was started successfully.", thePlayer, 255, 0, 0 )
			else -- If it wasn't successfully started...
			outputChatBox ( "An unexpected error occured.", thePlayer, 255, 0, 0 )
			end
			else -- If they didn't put a resource name...
			outputChatBox ( "Please specify a resource to start.", thePlayer, 255, 0, 0 )
			end
			end
			addCommandHandler ( "resource-start", startTheResource ) -- Make it trigger when somebody types "/resource-start"
	</syntaxhighlight>		</syntaxhighlight>

Sebassje at 13:30, 22 October 2009

2009-10-22T13:30:12Z

← Older revision		Revision as of 13:30, 22 October 2009
Line 16:		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.
	*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started. ~~'''1.0 onwards'''~~		*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started.
	*'''loadServerConfigs:''' A boolean specifying if server side config (XML) files should be loaded with the resource.		*'''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.

Sebassje at 19:39, 3 April 2009

2009-04-03T19:39:17Z

← Older revision		Revision as of 19:39, 3 April 2009
Line 16:		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.
	*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started. '''~~DP3~~ onwards'''		*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started. '''1.0 onwards'''
	*'''loadServerConfigs:''' A boolean specifying if server side config (XML) files should be loaded with the resource.		*'''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.

Jax at 09:15, 8 June 2008

2008-06-08T09:15:13Z

← Older revision		Revision as of 09:15, 8 June 2008
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	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] )		bool startResource ( resource resourceToStart, [bool persistent = false, bool startIncludedResources = true, bool loadServerConfigs = true, bool loadMaps = true, bool loadServerScripts = true, bool loadHTML = true, bool loadClientConfigs = true, bool loadClientScripts = true, bool loadFiles = true] )
	</syntaxhighlight>		</syntaxhighlight>

Line 16:		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.
			*'''startIncludedResources:''' A boolean specifying if the resource's included/dependant resources will be started. '''DP3 onwards'''
	*'''loadServerConfigs:''' A boolean specifying if server side config (XML) files should be loaded with the resource.		*'''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.

← Older revision		Revision as of 22:49, 6 September 2024
Line 49:		Line 49:

	==See Also==		==See Also==
	{{Resource_functions}}		{{Resource_functions\|server}}