Modules/FileSystem/translator/getDirs: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ This function returns a list of all directories that are found under the directory path. It is similar to scanDir but returns directories only. ==Syntax== <syntaxhighlight lang="lua"> table translator:getDirs ( string dirPath, bool recursive ) </syntaxhighlight> ==Arguments== *'''dirPath:''' a path to the directory the scan shall take place or start in *'''recursive:''' a boolean that specifies whether the whole direc...")
 
No edit summary
 
Line 1: Line 1:
<pageclass class="#3c82c8" subcaption="Translator function"></pageclass>
__NOTOC__
__NOTOC__
This function returns a list of all directories that are found under the directory path. It is similar to [[MTA:Eir/FileSystem/translator/scanDir|scanDir]] but returns directories only.
This function returns a list of all directories that are found under the directory path. It is similar to [[MTA:Eir/FileSystem/translator/scanDir|scanDir]] but returns directories only.

Latest revision as of 03:30, 23 January 2022

This function returns a list of all directories that are found under the directory path. It is similar to scanDir but returns directories only.

Syntax

table translator:getDirs ( string dirPath, bool recursive )

Arguments

  • dirPath: a path to the directory the scan shall take place or start in
  • recursive: a boolean that specifies whether the whole directory tree at dirPath should be included into the scan

Returns

This function returns a table of all matching directory entries for the performed scan. It returns false if dirPath is not a valid directory target for the translator.

Example

Click to collapse [-]
Client

This snippet is yet another alternative to output the count of directories and files in a folder.

-- Get a handle to the resource instance directory.
local resRoot = fileCreateTranslator( "/" );

local function getFilesystemObjectCounts( path )
    local fileCount = 0;
    local dirCount = 0;

    -- Query the counts.
    fileCount = #resRoot:getFiles( path, "*", false );
    dirCount = #resRoot:getDirs( path, false );

    -- Return the counts.
    return fileCount, dirCount;
end

-- Output the filesystem object counts for the resource instance root.
local fileCount, dirCount = getFilesystemObjectCounts( "/" );

outputChatBox( "found " .. fileCount .. " files and " .. dirCount .. " directories in the resource folder root." );

FileSystem Translator Functions