CopyResource: Difference between revisions

Latest revision as of 15:33, 7 November 2024

This function copies a specified resource with a new name.

Syntax

resource copyResource ( resource theResource, string newResourceName [, string organizationalDir ] )

OOP Syntax Help! I don't understand this!

Method: resource:copy(...)

Required Arguments

theResource: the resource which is going to be copied
newResourceName: the name that the copied resource will receive

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

organizationalDir: A string containing the path where the resource should be copied to (e.g. "[gamemodes]/[amx]").

Returns

Returns the resource element of the copy. Returns false if the arguments are incorrect.

Example

-- This script can backup your resource with a easy command! /backupresource [resourcename]
function backupResource (player,command,resourcetobackup) -- start the function
  if (resourcetobackup) and (getResourceFromName(resourcetobackup)) then -- check if the resource is exist
    copyResource (getResourceFromName(resourcetobackup),resourcetobackup .. "_backup") -- copy the resource and give it the name [resource]_backup
    outputChatBox ("Resource " .. resourcetobackup .. " succesfully backed up!",player,255,0,0,false) -- say it's OK!
  else -- if it isn't exist
    outputChatBox ("Resource can't be backed up! (don't forget the parameters!)",player,255,0,0,false) -- say it isn't exist!
  end
end
addCommandHandler ("backupresource",backupResouce) -- add command

@@ Line 5: / Line 5: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool copyResource ( resource theResource, string newResourceName )
+resource copyResource ( resource theResource, string newResourceName [, string organizationalDir ] )
 </syntaxhighlight>
+{{OOP||[[resource]]:copy}}
 ===Required Arguments===
 *'''theResource:''' the resource which is going to be copied
 *'''newResourceName:''' the name that the copied resource will receive
+===Optional Arguments===
+{{OptionalArg}}
+* '''organizationalDir''': A string containing the path where the resource should be copied to (e.g. "[gamemodes]/[amx]").
 ===Returns===
-Returns ''true'' if the resource was copied successfully, ''false'' otherwise.
+Returns the [[resource]] element of the copy. Returns ''false'' if the arguments are incorrect.
 ==Example==
 <syntaxhighlight lang="lua">
---TODO
+-- This script can backup your resource with a easy command! /backupresource [resourcename]
+function backupResource (player,command,resourcetobackup) -- start the function
+  if (resourcetobackup) and (getResourceFromName(resourcetobackup)) then -- check if the resource is exist
+    copyResource (getResourceFromName(resourcetobackup),resourcetobackup .. "_backup") -- copy the resource and give it the name [resource]_backup
+    outputChatBox ("Resource " .. resourcetobackup .. " succesfully backed up!",player,255,0,0,false) -- say it's OK!
+  else -- if it isn't exist
+    outputChatBox ("Resource can't be backed up! (don't forget the parameters!)",player,255,0,0,false) -- say it isn't exist!
+  end
+end
+addCommandHandler ("backupresource",backupResouce) -- add command
 </syntaxhighlight>
 ==See Also==
-{{Resource_functions}}
+{{Resource_functions|server}}
-[[Category:Needs_Example]]