FileCopy: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (7 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{Server client function}} | {{Server client function}} | ||
__NOTOC__ | __NOTOC__ | ||
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.}} | |||
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)}} | {{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== | ==Syntax== | ||
<syntaxhighlight lang="lua"> bool fileCopy ( string filePath , string copyToFilePath ) </syntaxhighlight> | <syntaxhighlight lang="lua"> | ||
bool fileCopy ( string filePath, string copyToFilePath [, bool overwrite = false ] ) | |||
</syntaxhighlight> | |||
{{OOP|This function is a static function underneath the File class.|[[File]].copy}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
* '''filePath''': The path of the file you want to copy. | * '''filePath''': The path of the file you want to copy. | ||
* '''copyToFilePath''': Where to copy the specified file to. | * '''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== | ==Returns== | ||
| Line 43: | Line 49: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
==See Also== | ==See Also== | ||
{{File functions}} | {{File functions}} | ||
[[pt-br:fileCopy]] | |||
Latest revision as of 17:07, 7 November 2024
This function copies a file.
| 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)