MTA:Eir/FileSystem/createFilesystemInterface - Revision history

Quiret at 21:50, 16 January 2022

2022-01-16T21:50:59Z

← Older revision		Revision as of 21:50, 16 January 2022
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function creates a FileSystem access point. An access point is your personal instance of the ~~MTA:~~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.		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~~.dll~~ module, it is highly suggested to restrict access to this function to priviledged resources!'''		'''When using the fileSystem module, it is highly suggested to restrict access to this function to priviledged resources!'''

	==Syntax==		==Syntax==

The GTA at 11:59, 1 February 2014

2014-02-01T11:59:08Z

← Older revision		Revision as of 11:59, 1 February 2014
Line 2:		Line 2:
	This function creates a FileSystem access point. An access point is your personal instance of the MTA: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.		This function creates a FileSystem access point. An access point is your personal instance of the MTA: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.dll module, it highly suggested to restrict access to this function to priviledged resources!'''		'''When using the fileSystem.dll module, it is highly suggested to restrict access to this function to priviledged resources!'''

	==Syntax==		==Syntax==

The GTA at 11:58, 1 February 2014

2014-02-01T11:58:57Z

← Older revision		Revision as of 11:58, 1 February 2014
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function creates a FileSystem access point. An access point is your personal instance of the MTA: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.		This function creates a FileSystem access point. An access point is your personal instance of the MTA: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.dll module, it highly suggested to restrict access to this function to priviledged resources!'''

	==Syntax==		==Syntax==

The GTA at 09:56, 29 January 2014

2014-01-29T09:56:49Z

← Older revision		Revision as of 09:56, 29 January 2014
Line 29:		Line 29:

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

The GTA at 00:50, 29 January 2014

2014-01-29T00:50:09Z

← Older revision		Revision as of 00:50, 29 January 2014
Line 11:		Line 11:

	==Example==		==Example==
	<section name="~~Client~~" class="~~client~~" show="true">		<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.		This snippet sets up access to your resource in a simple server-side resource environment when using the FileSystem module.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

The GTA at 00:45, 29 January 2014

2014-01-29T00:45:12Z

← Older revision		Revision as of 00:45, 29 January 2014
Line 10:		Line 10:
	This function returns the table that denotes the '''FileSystem module namespace'''.		This function returns the table that denotes the '''FileSystem module namespace'''.

			==Example==
			<section name="Client" class="client" 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 is 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>
	{{:MTA:Eir/FileSystem/functions}}		{{:MTA:Eir/FileSystem/functions}}

The GTA at 00:31, 29 January 2014

2014-01-29T00:31:08Z

← Older revision		Revision as of 00:31, 29 January 2014
Line 10:		Line 10:
	This function returns the table that denotes the '''FileSystem module namespace'''.		This function returns the table that denotes the '''FileSystem module namespace'''.

	~~==See also==~~
	{{:MTA:Eir/FileSystem/functions}}		{{:MTA:Eir/FileSystem/functions}}

The GTA at 00:30, 29 January 2014

2014-01-29T00:30:11Z

← Older revision		Revision as of 00:30, 29 January 2014
Line 11:		Line 11:

	==See also==		==See also==
	[[:MTA:Eir/FileSystem/functions~~/]]~~		{{:MTA:Eir/FileSystem/functions}}

The GTA: Created page with "NOTOC This function creates a FileSystem access point. An access point is your personal instance of the MTA:Eir FileSystem. The table returned by this function is the module ..."

2014-01-29T00:26:32Z

Created page with "__NOTOC__ This function creates a FileSystem access point. An access point is your personal instance of the MTA:Eir FileSystem. The table returned by this function is the module ..."

New page

__NOTOC__
This function creates a FileSystem access point. An access point is your personal instance of the MTA: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.

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

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

==See also==
[[:MTA:Eir/FileSystem/functions/]]