Modules/FileSystem/createFileIterative: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 11: Line 11:
*'''prefix''': part of file path before the numeric insert
*'''prefix''': part of file path before the numeric insert
*'''suffix''': part of file path after the numeric insert (for example the file extention)
*'''suffix''': part of file path after the numeric insert (for example the file extention)
*'''maxIterations''': integral number of tries for the existing filename collisions
*'''maxIterations''': integral number of tries for the existing filename collisions (greater than 0)


==Returns==
==Returns==

Revision as of 15:39, 20 January 2022

This function attempts to create a file with numeric iteration for filename collision avoidance. If a specific filename is taken then the algorithm will try to create the next file with increased numeric insert.

Syntax

file fsnamespace.createFileIterative( translator target, string prefix, string suffix, int maxIterations )

Arguments

  • target: the file translator based on which to create the file
  • prefix: part of file path before the numeric insert
  • suffix: part of file path after the numeric insert (for example the file extention)
  • maxIterations: integral number of tries for the existing filename collisions (greater than 0)

Returns

This function returns a newly created file handle distinct from any other colliding one if successful, false otherwise.

Example

-- TODO

FileSystem Namespace Functions

FileSystem File Functions

FileSystem Translator Functions