MTA:Eir/FileSystem/translator/getDirs: Difference between revisions
Jump to navigation
Jump to search
(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 ...") |
No edit summary |
||
| 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== | ||
Revision as of 07:33, 30 January 2014
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
bool translator.getDirs ( string dirPath, string wildcard, bool recursive )
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. It returns false if dirPath is not a valid directory target for the translator.
Example
Click to collapse [-]
ClientThis 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 = #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." );