FileRename: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Portuguese version indexed) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
Renames the specified file. | Renames the specified file. | ||
{{Note|Also with this function you can move specified file to a new location, new folder or even to another resource's folder. But for this action executing resource must have 'ModifyOtherObjects' ACL right set to ''true''.}} | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool fileRename ( string filePath, string newFilePath ) | bool fileRename ( string filePath, string newFilePath ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP|This function is a static function underneath the File class.|[[File]].rename}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary. | *'''filePath:''' The [[filepath]] of the source file in the following format: '''":resourceName/path"'''. 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary. | ||
*'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format. | *'''newFilePath:''' Destination [[filepath]] for the specified source file in the same format. | ||
===Returns=== | ===Returns=== | ||
| Line 50: | Line 36: | ||
==See Also== | ==See Also== | ||
{{File functions}} | {{File functions}} | ||
[[pt-br:fileRename]] | |||
Latest revision as of 19:51, 20 December 2023
Renames the specified file.
Syntax
bool fileRename ( string filePath, string newFilePath )
OOP Syntax Help! I don't understand this!
- Note: This function is a static function underneath the File class.
- Method: File.rename(...)
Required Arguments
- filePath: The filepath of the source file in the following format: ":resourceName/path". 'resourceName' is the name of the resource the file is in, and 'path' is the path from the root directory of the resource to the file. If the file is in the current resource, only the file path is necessary.
- newFilePath: Destination filepath for the specified source file in the same format.
Returns
If successful, returns true. Otherwise returns false.
Example
This example renames the file test1.txt that is in the root of the current resource to test2.txt.
if fileRename( "test1.txt", "test2.txt" ) then
outputConsole("File `test1.txt` successfully renamed to `test2.txt`")
else
outputConsole("Unable to rename `test1.txt`")
end
This example moves the file test1.txt that is in the root of the current resource to myFolder folder. If this folder is not exists, it will be created before moving the file test1.txt.
if fileRename( "test1.txt", "myFolder/test1.txt" ) then
outputConsole("File `test1.txt` successfuly moved to `myFolder` folder")
else
outputConsole("Unable to move `test1.txt`")
end