Danilo at 03:30, 23 January 2022

2022-01-23T03:30:55Z

← Older revision		Revision as of 03:30, 23 January 2022
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.

Danilo: 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== 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 direc..."

2022-01-19T03:01:10Z

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..."

New page

__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.

==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 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==
<section name="Client" class="client" show="true">
This snippet is yet another alternative to output the count of directories and files in a folder.
<syntaxhighlight lang="lua">
-- 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." );
</syntaxhighlight>
</section>
{{:Modules/FileSystem/translator/functions}}

Modules/FileSystem/translator/getDirs - Revision history

Danilo at 03:30, 23 January 2022