MTA:Eir/FileSystem/translator/open - Revision history

Quiret at 23:22, 16 January 2022

2022-01-16T23:22:57Z

← Older revision		Revision as of 23:22, 16 January 2022
Line 41:		Line 41:
	local function moduleFileIterator( filePath )		local function moduleFileIterator( filePath )
	-- Create an entry for this module.		-- Create an entry for this module.
	local moduleName = fsys.root.relPath( filePath );		local moduleName = fsys.root:relPath( filePath );
	local moduleStats = fsys.root.stat( filePath );		local moduleStats = fsys.root:stat( filePath );

	local entry = {		local entry = {
Line 54:		Line 54:

	-- Loop through all server modules.		-- Loop through all server modules.
	fsys.root.chdir( "mods/deathmatch/modules/" );		fsys.root:chdir( "mods/deathmatch/modules/" );
	fsys.root.scanDirEx( "", "*", nil, moduleFileIterator, false );		fsys.root:scanDirEx( "", "*", nil, moduleFileIterator, false );

	-- Function to get a module into by name.		-- Function to get a module into by name.
Line 103:		Line 103:

	if ( fileHandle ) then		if ( fileHandle ) then
	fileContents = fileHandle.read( fileHandle.size() );		fileContents = fileHandle:read( fileHandle.size() );

	-- Clean up our file handle.		-- Clean up our file handle.
	fileHandle.destroy();		fileHandle:destroy();
	end		end

Quiret at 23:21, 16 January 2022

2022-01-16T23:21:02Z

← Older revision		Revision as of 23:21, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	file, ~~failreason~~ translator.open ( string filePath, string fileMode )		file, string translator:open ( string filePath, string fileMode )
	</syntaxhighlight>		</syntaxhighlight>

Quiret at 22:11, 16 January 2022

2022-01-16T22:11:42Z

← Older revision		Revision as of 22:11, 16 January 2022
Line 13:		Line 13:
	==Returns==		==Returns==
	This function returns the '''FileSystem file''' class that can be used to retrieve or store data persistently. Returns '''false''' if the file failed to open and the '''reason of failure as string'''.		This function returns the '''FileSystem file''' class that can be used to retrieve or store data persistently. Returns '''false''' if the file failed to open and the '''reason of failure as string'''.

			===Failure reasons===
			* unknown error
			* path out of scope
			* invalid parameters
			* resources exhausted
			* access denied
			* not found
			* already exists

	==Example==		==Example==

Quiret at 22:07, 16 January 2022

2022-01-16T22:07:35Z

← Older revision		Revision as of 22:07, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	file translator.open ( string filePath, string fileMode )		file, failreason translator.open ( string filePath, string fileMode )
	</syntaxhighlight>		</syntaxhighlight>

Line 12:		Line 12:

	==Returns==		==Returns==
	This function returns the '''FileSystem file''' class that can be used to retrieve or store data persistently. Returns '''false''' if the file failed to open ~~for~~ ''~~some~~ reason''.		This function returns the '''FileSystem file''' class that can be used to retrieve or store data persistently. Returns '''false''' if the file failed to open and the '''reason of failure as string'''.

	==Example==		==Example==

The GTA: added server example

2014-02-02T20:44:45Z

added server example

@@ Line 15: / Line 15: @@
 ==Example==
 <section name="Client" class="client" show="true">
 This snippet attempts to open a file and output its contents inside of a CEGUI memo.

The GTA: Created page with "NOTOC This function opens a link to a file instance on a given MTA:Eir FileSystem translator. Using a file link, you can write and/or receive data from filesystems. ==Syntax..."

2014-01-29T02:51:41Z

Created page with "__NOTOC__ This function opens a link to a file instance on a given MTA:Eir FileSystem translator. Using a file link, you can write and/or receive data from filesystems. ==Syntax..."

New page

__NOTOC__
This function opens a link to a file instance on a given MTA:Eir FileSystem translator. Using a file link, you can write and/or receive data from filesystems.

==Syntax==
<syntaxhighlight lang="lua">
file translator.open ( string filePath, string fileMode )
</syntaxhighlight>

==Arguments==
*'''filePath:''' the path to the file that should be opened
*'''fileMode:''' an ANSI file mode descriptor (can be 'w', 'r' or 'a', with 'b' and/or '+' appended)

==Returns==
This function returns the '''FileSystem file''' class that can be used to retrieve or store data persistently. Returns '''false''' if the file failed to open for ''some reason''.

==Example==
<section name="Client" class="client" show="true">
This snippet attempts to open a file and output its contents inside of a CEGUI memo.
<syntaxhighlight lang="lua">
-- Get the screen size so we can scale the memo properly
local screenWidth, screenHeight = guiGetScreenSize();

-- Make the memo cover nearly the entire screen.
local myMemo = guiCreateMemo( 20, 20, screenWidth - 40, screenHeight - 40, "", false );

-- Read the contents of some file.
local fileContents = "";

local fileHandle = fileOpen( "someFile.txt", "rb" );

if ( fileHandle ) then
fileContents = fileHandle.read( fileHandle.size() );

-- Clean up our file handle.
fileHandle.destroy();
end

-- Update the memo.
guiSetText( myMemo, fileContents );
</syntaxhighlight>
</section>
{{:MTA:Eir/FileSystem/translator/functions}}

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