Modules/FileSystem/createFilesystemInterface - Revision history

Danilo: Created page with "NOTOC This function creates a FileSystem access point. An access point is your personal instance of the Eir FileSystem. The table returned by this function is the module namespace. There are no limits as to how many access points can be live at a time. '''When using the fileSystem module, it is highly suggested to restrict access to this function to priviledged resources!''' ==Syntax== table createFilesystemInterface ()
2022-01-19T02:42:23Z

Created page with "NOTOC This function creates a FileSystem access point. An access point is your personal instance of the Eir FileSystem. The table returned by this function is the module namespace. There are no limits as to how many access points can be live at a time. '''When using the fileSystem module, it is highly suggested to restrict access to this function to priviledged resources!''' ==Syntax== <syntaxhighlight lang="lua"> table createFilesystemInterface () </syntaxhighligh..."

New page
NOTOC
This function creates a FileSystem access point. An access point is your personal instance of the Eir FileSystem. The table returned by this function is the module namespace. There are no limits as to how many access points can be live at a time.

'''When using the fileSystem module, it is highly suggested to restrict access to this function to priviledged resources!'''

==Syntax==
<syntaxhighlight lang="lua">
table createFilesystemInterface ()
</syntaxhighlight>

==Returns==
This function returns the table that denotes the '''FileSystem module namespace'''.

==Example==
<section name="Server" class="server" show="true">
This snippet sets up access to your resource in a simple server-side resource environment when using the FileSystem module.
<syntaxhighlight lang="lua">
-- Create the interface.
local fsys = createFilesystemInterface();

-- Make sure we have access to the module.
-- Access could be blocked by acl.xml priviledges.
if not ( fsys ) then
outputDebugString( "could not create FileSystem interface" );
return false;
end

-- Assume the resource is located inside a folder in the deathmatch resources directory.
-- Then we create a raw OS filesystem link to it.
local resRoot = fsys.createTranslator( "mods/deathmatch/resources/" .. getResourceName(resource) .. "/" );

-- Check that we have access (i.e. passed OS priviledges test) for this folder.
-- Will fail if the resource is not inside a folder in the deathmatch resources directory.
if not ( resRoot ) then
outputDebugString( "cannot link resource instance directory" );
return false;
end

-- Open the "meta.xml" file.
local metaFile = resRoot.open( "meta.xml", "rb" );

-- Success!
</syntaxhighlight>
</section>
{{:Modules/FileSystem/functions}}