DeleteResource - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T15:33:46Z

Remove obsolete Requirements section

← Older revision		Revision as of 15:33, 7 November 2024
Line 52:		Line 52:
	end )		end )
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|1.1.1-9.03316\|n/a\|}}~~

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

FileEX: /* See Also */

2024-09-06T22:46:30Z

Ccw at 22:55, 26 September 2016

2016-09-26T22:55:07Z

← Older revision		Revision as of 22:55, 26 September 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	~~{{Note\|This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.}}~~		This function deletes a resource from the MTA memory and moves it to the '''/resources-cache/trash/''' directory.
	This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Strix: fix oop syntax

2015-01-05T12:14:28Z

fix oop syntax

← Older revision		Revision as of 12:14, 5 January 2015
Line 7:		Line 7:
	bool deleteResource ( string resourceName )		bool deleteResource ( string resourceName )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[~~resource~~]]:delete}}		{{OOP\|This function is a static function underneath the Resource class.\|[[Resource]].delete}}
	===Required Arguments===		===Required Arguments===
	*'''resourceName:''' The name of resource to delete.		*'''resourceName:''' The name of resource to delete.

Qaisjp: add note template

2015-01-04T14:03:40Z

add note template

← Older revision		Revision as of 14:03, 4 January 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
			{{Note\|This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.}}
	This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.		This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.

	~~'''Note:''' This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.~~

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Strix at 16:27, 1 January 2015

2015-01-01T16:27:37Z

← Older revision		Revision as of 16:27, 1 January 2015
Line 9:		Line 9:
	bool deleteResource ( string resourceName )		bool deleteResource ( string resourceName )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[resource]]:delete}}
	===Required Arguments===		===Required Arguments===
	*'''resourceName:''' The name of resource to delete.		*'''resourceName:''' The name of resource to delete.

X86dev at 11:42, 26 July 2012

2012-07-26T11:42:04Z

← Older revision		Revision as of 11:42, 26 July 2012
Line 1:		Line 1:
	~~{{New feature/item\|3.0120\|1.2\|3316\|~~
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
Line 56:		Line 55:
	end )		end )
	</syntaxhighlight>		</syntaxhighlight>
	}}

	==Requirements==		==Requirements==

-ffs-Sniper at 22:54, 28 March 2012

2012-03-28T22:54:01Z

← Older revision		Revision as of 22:54, 28 March 2012
Line 21:		Line 21:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler ( "removeresource",		addCommandHandler ( "removeresource",
	function( playerSource, commandName, name )		function ( playerSource, commandName, name )
	--Check if it is an admin using this command		--Check if it is an admin using this command
	if not isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( playerSource ) ), aclGetGroup ( "Admin" ) ) then		if not isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( playerSource ) ), aclGetGroup ( "Admin" ) ) then

-ffs-Sniper: Small update for the example

2012-03-17T10:36:23Z

Small update for the example

← Older revision		Revision as of 10:36, 17 March 2012
Line 20:		Line 20:
	This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).		This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("removeresource",		addCommandHandler ( "removeresource",
	function(~~player~~, ~~cmd~~, name)		function( playerSource, commandName, name )
	--Check if it is an admin using this command		--Check if it is an admin using this command
	if not (isObjectInACLGroup("user."..getAccountName(getPlayerAccount(~~player~~)),aclGetGroup("Admin"))) then		if not isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( playerSource ) ), aclGetGroup ( "Admin" ) ) then
	outputChatBox("You are not allowed to use this command", ~~player~~)		outputChatBox ( "You are not allowed to use this command", playerSource )
	return		return
	end		end
	--Did the user pass a valid resource name?		--Did the user pass a valid resource name?
	if not (name) or (name == ""~~) and (~~name == " ") then		if not name or name == "" or name == " " then
	outputChatBox("An invalid resource name has been passed (/removeresource <name>)", ~~player~~)		outputChatBox ( "An invalid resource name has been passed (/removeresource <name>)", playerSource )
	return		return
	end		end
	--Let us check if the resource name exists		--Let us check if the resource name exists
	--Get all resources		--Get all resources
	local resourceTable = getResources()		local resourceTable = getResources ( )
	for resourceKey, resourceValue in ipairs(resourceTable) do		for resourceKey, resourceValue in ipairs ( resourceTable ) do
	local resourceName = getResourceName(resourceValue)		local resourceName = getResourceName ( resourceValue )
	--Does the resource exist?		--Does the resource exist?
	if (name == resourceName) then		if name == resourceName then
	--Stop the resource (maybe it is running)		--Stop the resource (maybe it is running)
	stopResource(resourceValue)		stopResource ( resourceValue )
	--Delete it		--Delete it
	local deleted = deleteResource(name)		local deleted = deleteResource ( name )
	if (deleted) then		if deleted then
	outputChatBox("Resource "..name.." has been successfully removed", ~~player~~)		outputChatBox ( "Resource " .. name .. " has been successfully removed", playerSource )
	else		else
	outputChatBox("There is an unknown problem with the resource", ~~player~~)		outputChatBox ( "There is an unknown problem with the resource", playerSource )
	end		end
	--The function is finished and was successful, return to stop it		--The function is finished and was successful, return to stop it
Line 53:		Line 53:
	end		end
	--If a resource with the specified name does not exist show an error message		--If a resource with the specified name does not exist show an error message
	outputChatBox("The specified resource does not exist", ~~player~~)		outputChatBox ( "The specified resource does not exist", playerSource )
	end)		end )
	</syntaxhighlight>		</syntaxhighlight>
	}}		}}

-ffs-Sniper: Completely wrong example replaced by a useful and working example

2012-03-17T10:25:28Z

Completely wrong example replaced by a useful and working example

← Older revision		Revision as of 10:25, 17 March 2012
Line 18:		Line 18:

	==Example==		==Example==
	This example ~~checks~~ to ~~see if there's 2 resources~~.		This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~addEventHandler~~("~~onResourceStart~~",~~getResourceRootElement~~(~~getThisResource~~()),		addCommandHandler("removeresource",
	~~function~~()		function(player, cmd, name)
	~~resources = getResources~~() --~~Get all resources~~		--Check if it is an admin using this command
	if (~~getResourceState~~(~~resources)~~ == "~~loaded~~" and "~~running" or~~ "~~loaded~~" ~~and "starting~~") ~~then~~ --~~Checks to see~~ if ~~there's to~~ resources ~~that's loaded and~~ running ~~or loaded and starting up~~		if not (isObjectInACLGroup("user."..getAccountName(getPlayerAccount(player)),aclGetGroup("Admin"))) then
	stopResource(~~resources~~)		outputChatBox("You are not allowed to use this command", player)
	deleteResource(~~resources~~)		return
	end		end
			--Did the user pass a valid resource name?
			if not (name) or (name == "") and (name == " ") then
			outputChatBox("An invalid resource name has been passed (/removeresource <name>)", player)
			return
			end
			--Let us check if the resource name exists
			--Get all resources
			local resourceTable = getResources()
			for resourceKey, resourceValue in ipairs(resourceTable) do
			local resourceName = getResourceName(resourceValue)
			--Does the resource exist?
			if (name == resourceName) then
			--Stop the resource (maybe it is running)
			stopResource(resourceValue)
			--Delete it
			local deleted = deleteResource(name)
			if (deleted) then
			outputChatBox("Resource "..name.." has been successfully removed", player)
			else
			outputChatBox("There is an unknown problem with the resource", player)
			end
			--The function is finished and was successful, return to stop it
			return
			end
			end
			--If a resource with the specified name does not exist show an error message
			outputChatBox("The specified resource does not exist", player)
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>

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

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