Modules/FileSystem/translator/createDir

From Multi Theft Auto: Wiki
Revision as of 02:50, 19 January 2022 by Danilo (talk | contribs) (Created page with "__NOTOC__ This function creates a directory inside of a translator directory hierarchy. ==Syntax== <syntaxhighlight lang="lua"> bool translator:createDir ( string dirPath ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to a directory that should be created ==Returns== This function returns '''true''' if the given path is a valid directory path relative to the translator, '''false''' otherwise. ==Example== <section name="Client" class="client" show="true"> T...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function creates a directory inside of a translator directory hierarchy.

Syntax

bool translator:createDir ( string dirPath )

Arguments

  • dirPath: a path to a directory that should be created

Returns

This function returns true if the given path is a valid directory path relative to the translator, false otherwise.

Example

Click to collapse [-]
Client

This snippet creates a folder hierarchy.

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

-- Create some folders.
resRoot:createDir( "theDirectory/" ); -- successfully creates "theDirectory" folder
resRoot:createDir( "secondDirectory" ); -- fails to create "secondDirectory" as intended, because it is not a valid dirPath
resRoot:createDir( "thirdDirectory/fourthDirectory/documents/" ); -- successfully creates three directories at a time
resRoot:createDir( "../hax/" ); -- fails to create "hax" directory, because the path is not relative to the translator anymore

FileSystem Translator Functions