FileCopy
From Multi Theft Auto: Wiki
This function copies a file.
| Note: The file functions should not be used to implement configuration files. It is encouraged to use the XML functions for this instead. |
| Tip: If you do not want to share the content of the created file with other servers, prepend the file path with @ (See filepath for more information) |
Syntax
bool fileCopy ( string filePath, string copyToFilePath [, bool overwrite = false ] )
OOP Syntax Help! I don't understand this!
- Note: This function is a static function underneath the File class.
- Method: File.copy(...)
Required Arguments
- filePath: The path of the file you want to copy.
- copyToFilePath: Where to copy the specified file to.
Optional Arguments
- overwrite: If set to true it will overwrite a file that already exists at copyToFilePath.
Returns
Return true if the file was copied, else false if the 'filePath' doesn't exist.
Example
Click to collapse [-]
ServerThis example copies a file called 'test.txt' and called it 'test1.txt'.
addEventHandler("onResourceStart", resourceRoot, function(res)
local filePath = ":"..getResourceName(res).."/test.txt"
fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
if fileCopy(filePath, ":"..getResourceName(res).."/test1.txt") then
outputChatBox("File was successfully copied!", root, 0, 100, 0)
else
outputChatBox("File was not successfully copied, probably because it doesn't exist.", root, 100, 0, 0)
end
end)
Click to collapse [-]
ClientThis example copies a file called 'test.txt' and called it 'test1.txt'.
addEventHandler("onClientResourceStart", resourceRoot, function(res)
local filePath = ":"..getResourceName(res).."/test.txt"
fileCreate(filePath) --create the file in this resource and name it 'test.txt'.
if fileCopy(filePath,":"..getResourceName(res).."/test1.txt") then
outputChatBox("File was successfully copied!", 0, 100, 0)
else
outputChatBox("File was not successfully copied, probably because it doesn't exist.", 100, 0, 0)
end
end)
| Minimum supported server | 1.3.1 |
|---|---|
| Minimum supported client | 1.3.1 |
Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.3.1" client="1.3.1" />
