Modules/FileSystem/translator/copy

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

This function copies a file from a source location to a file at the destination. The contents of the source file are copied, so that source and destination have the same content. Since the transactions happen through kernel-calls, this function is faster than performing the copying yourself through Lua strings.

Syntax

bool translator:copy ( string srcPath, string dstPath )

Arguments

  • srcPath: a path to the source file
  • dstPath: the path to the new file that should be copied into

Returns

This function returns true if the file pointed at by srcPath is an accessible file that can be read from and the requested file a dstPath could be created and written to, false otherwise.

Example

Click to collapse [-]
Client

This snippet backups a copy of client-side configuration for safety purposes.

-- Create a generic translator.
local resRoot = fileCreateTranslator( "/" );

resRoot:copy( "config.xml", "backup/config.xml" );

FileSystem Translator Functions