The GTA at 23:37, 1 February 2014

2014-02-01T23:37:13Z

← Older revision		Revision as of 23:37, 1 February 2014
Line 14:		Line 14:
	==Returns==		==Returns==
	This function returns the '''FileSystem translator''' that grants access to contents of an archive.		This function returns the '''FileSystem translator''' that grants access to contents of an archive.

			==Remarks==
			This function is currently unavailable in the fileSystem.dll module.

	==Example==		==Example==

The GTA at 12:12, 1 February 2014

2014-02-01T12:12:21Z

← Older revision		Revision as of 12:12, 1 February 2014
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~translator~~ fsnamespace.createArchiveTranslator ( file fileHandle )		atranslator fsnamespace.createArchiveTranslator ( file fileHandle )
	</syntaxhighlight>		</syntaxhighlight>

Line 59:		Line 59:

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

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

The GTA: Created page with "NOTOC This function creates a FileSystem archive translator. A FileSystem archive translator is a virtual FileSystem that grants access to the contents of archives. You can b..."

2014-01-29T01:42:30Z

Created page with "__NOTOC__ This function creates a FileSystem archive translator. A FileSystem archive translator is a virtual FileSystem that grants access to the contents of archives. You can b..."

New page

__NOTOC__
This function creates a FileSystem archive translator. A FileSystem archive translator is a virtual FileSystem that grants access to the contents of archives. You can browse archives the same way as you would with native OS directories. The archive implementations usually cache their operations inside of the OS temp directory.

Currently, only .zip archives are supported.

==Syntax==
<syntaxhighlight lang="lua">
translator fsnamespace.createArchiveTranslator ( file fileHandle )
</syntaxhighlight>

==Arguments==
*'''fileHandle:''' a MTA:Eir FileSystem file/stream class that contains the archive.

==Returns==
This function returns the '''FileSystem translator''' that grants access to contents of an archive.

==Example==
<section name="Client" class="client" show="true">
This snippet lists the contents of a .zip archive.
<syntaxhighlight lang="lua">
-- Opens the file link to our .zip archive.
-- The input fileStream can actually be any file/stream class that is exported to the script.
-- The implementation is allowed to throw exceptions if a file/stream class is incompatible.
local zipFile = fileOpen( "theArchive.zip", "rb" );

-- Check that we can access that .zip archive.
if not ( zipFile ) then
outputDebugString( "could not open theArchive.zip" );
return false;
end

-- Try to open a content link to the .zip archive.
-- This operation will fail is the archive is not valid.
local zipTranslator = fileOpenArchive( zipFile );

if not ( zipTranslator ) then
outputDebugString( "could not access the contents of theArchive.zip" );
outputDebugString( "the archive could be damaged" );
return false;
end

-- This table shall contain all filenames of the archive.
local fileEntries = {};

local function fileIterator( filePath )
-- Add the filename to our list.
table.insert( fileEntries, zipTranslator.relPathRoot( filePath ) );
end

zipTranslator.scanDirEx( "/", "*", nil, fileIterator, true );

-- List the filenames on the chatbox.
for m,n in ipairs( fileEntries ) do
outputChatBox( n );
end
</syntaxhighlight>
</section>
{{:MTA:Eir/FileSystem/namespace/functions}}

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

MTA:Eir/FileSystem/createArchiveTranslator - Revision history

The GTA at 23:37, 1 February 2014

The GTA at 12:12, 1 February 2014

The GTA: Created page with "__NOTOC__ This function creates a FileSystem archive translator. A FileSystem archive translator is a virtual FileSystem that grants access to the contents of archives. You can b..."

The GTA: Created page with "NOTOC This function creates a FileSystem archive translator. A FileSystem archive translator is a virtual FileSystem that grants access to the contents of archives. You can b..."