MTA:Eir/FileSystem/translator/getDirs - Revision history

Quiret at 23:30, 16 January 2022

2022-01-16T23:30:05Z

← Older revision		Revision as of 23:30, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table translator.getDirs ( string dirPath, bool recursive )		table translator:getDirs ( string dirPath, bool recursive )
	</syntaxhighlight>		</syntaxhighlight>

Line 26:		Line 26:

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

	-- Return the counts.		-- Return the counts.

The GTA at 07:40, 30 January 2014

2014-01-30T07:40:18Z

← Older revision		Revision as of 07:40, 30 January 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function returns a list of all directories that are found under the ~~wild-card and~~ directory ~~parameters~~. 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.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table translator.getDirs ( string dirPath~~, string wildcard~~, bool recursive )		table translator.getDirs ( string dirPath, bool recursive )
	</syntaxhighlight>		</syntaxhighlight>

	==Arguments==		==Arguments==
	*'''dirPath:''' a path to the directory the scan shall take place or start in		*'''dirPath:''' a path to the directory the scan shall take place or start in
	*'''wildcard:''' glob-style wild-card for filename matching; every filename that matches the wild-card is returned
	*'''recursive:''' a boolean that specifies whether the whole directory tree at dirPath should be included into the scan		*'''recursive:''' a boolean that specifies whether the whole directory tree at dirPath should be included into the scan

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

	-- Return the counts.		-- Return the counts.

The GTA at 07:34, 30 January 2014

2014-01-30T07:34:51Z

← Older revision		Revision as of 07:34, 30 January 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to [[MTA:Eir/FileSystem/translator/scanDir]] but returns directories only.		This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to [[MTA:Eir/FileSystem/translator/scanDir\|scanDir]] but returns directories only.

	==Syntax==		==Syntax==

The GTA at 07:34, 30 January 2014

2014-01-30T07:34:17Z

← Older revision		Revision as of 07:34, 30 January 2014
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~bool~~ translator.getDirs ( string dirPath, string wildcard, bool recursive )		table translator.getDirs ( string dirPath, string wildcard, bool recursive )
	</syntaxhighlight>		</syntaxhighlight>

The GTA at 07:33, 30 January 2014

2014-01-30T07:33:51Z

← Older revision		Revision as of 07:33, 30 January 2014
Line 13:		Line 13:

	==Returns==		==Returns==
	This function returns a table of all matching directory entries for the performed scan.		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==		==Example==

The GTA: Created page with "NOTOC This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to MTA:Eir/FileSystem/translator/scanDir ..."

2014-01-30T07:33:08Z

Created page with "__NOTOC__ This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to MTA:Eir/FileSystem/translator/scanDir ..."

New page

__NOTOC__
This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to [[MTA:Eir/FileSystem/translator/scanDir]] but returns directories only.

==Syntax==
<syntaxhighlight lang="lua">
bool translator.getDirs ( string dirPath, string wildcard, bool recursive )
</syntaxhighlight>

==Arguments==
*'''dirPath:''' a path to the directory the scan shall take place or start in
*'''wildcard:''' glob-style wild-card for filename matching; every filename that matches the wild-card is returned
*'''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.

==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 = #getFiles( path, "*", false );
dirCount = #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>
{{:MTA:Eir/FileSystem/translator/functions}}

MTA:Eir/FileSystem/translator/getDirs - Revision history

Quiret at 23:30, 16 January 2022

The GTA at 07:40, 30 January 2014

The GTA at 07:34, 30 January 2014

The GTA at 07:34, 30 January 2014

The GTA at 07:33, 30 January 2014

The GTA: Created page with "__NOTOC__ This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to MTA:Eir/FileSystem/translator/scanDir ..."

The GTA: Created page with "NOTOC This function returns a list of all directories that are found under the wild-card and directory parameters. It is similar to MTA:Eir/FileSystem/translator/scanDir ..."