MTA:Eir/FileSystem/createTranslator - Revision history

The GTA: added server example

2014-02-02T20:06:06Z

added server example

@@ Line 14: / Line 14: @@
 ==Example==
-<section name="Client" class="client" show="true">
+<section name="Server" class="server" show="true">
 This snippet links all directories inside of your resource instance folder using translators and lists them in a dictionary under their name.
 <syntaxhighlight lang="lua">

The GTA at 01:21, 29 January 2014

2014-01-29T01:21:36Z

← Older revision		Revision as of 01:21, 29 January 2014
Line 44:		Line 44:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
			{{:MTA:Eir/FileSystem/namespace/functions}}

	{{:MTA:Eir/FileSystem/translator/functions}}		{{:MTA:Eir/FileSystem/translator/functions}}

The GTA at 01:20, 29 January 2014

2014-01-29T01:20:44Z

← Older revision		Revision as of 01:20, 29 January 2014
Line 44:		Line 44:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	{{:MTA:Eir/FileSystem/functions}}
			{{:MTA:Eir/FileSystem/translator/functions}}

The GTA: Created page with "NOTOC This function creates a FileSystem translator. A FileSystem translator represents a directory on a real or virtual filesystem. Through translators you get access to the..."

2014-01-29T01:20:05Z

Created page with "__NOTOC__ This function creates a FileSystem translator. A FileSystem translator represents a directory on a real or virtual filesystem. Through translators you get access to the..."

New page

__NOTOC__
This function creates a FileSystem translator. A FileSystem translator represents a directory on a real or virtual filesystem. Through translators you get access to the files that reside in their directory trees. The translator returned by this function usually represents an OS filesystem directory.

==Syntax==
<syntaxhighlight lang="lua">
translator fsnamespace.createTranslator( string rootPath )
</syntaxhighlight>

==Arguments==
*'''rootPath:''' the absolute path to the directory that you want access to.

==Returns==
This function returns the '''FileSystem translator''' that grants access to files in the requested directory.

==Example==
<section name="Client" class="client" show="true">
This snippet links all directories inside of your resource instance folder using translators and lists them in a dictionary under their name.
<syntaxhighlight lang="lua">
-- Dictionary that will contain all directory links of our resource.
local dirs = {};

-- Create a translator to the resource root.
local resRoot = fileCreateTranslator( "/" );

local function dirIterator( dirPath )
-- get the simple name of this directory.
-- the simple name is the path relative to resRoot without the '/'
local simpleName = resRoot.relPathRoot( dirPath );
simpleName = string.sub( simpleName, 1, #simpleName - 1 );

-- link this directory and set it into our dirs dictionary.
-- we should always pass the absolute directory to this function.
local translator = fileCreateTranslator( dirPath );

dirs[simpleName] = translator;
end

local function fileIterator( filePath )
-- do nothing.
return;
end

resRoot.scanDirEx( "/", "*", dirIterator, fileIterator, false );
</syntaxhighlight>
</section>
{{:MTA:Eir/FileSystem/functions}}

MTA:Eir/FileSystem/createTranslator - Revision history

The GTA: added server example

The GTA at 01:21, 29 January 2014

The GTA at 01:20, 29 January 2014

The GTA: Created page with "__NOTOC__ This function creates a FileSystem translator. A FileSystem translator represents a directory on a real or virtual filesystem. Through translators you get access to the..."

The GTA: Created page with "NOTOC This function creates a FileSystem translator. A FileSystem translator represents a directory on a real or virtual filesystem. Through translators you get access to the..."