Quiret at 23:45, 16 January 2022

2022-01-16T23:45:23Z

← Older revision		Revision as of 23:45, 16 January 2022
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int file.write ( string dataString )		int file:write ( string dataString )
	</syntaxhighlight>		</syntaxhighlight>

Line 57:		Line 57:

	-- Write the amount of log entries.		-- Write the amount of log entries.
	logFile.writeShort( #logEntries );		logFile:writeShort( #logEntries );

	-- Write the log entries.		-- Write the log entries.
Line 63:		Line 63:
	local encryptedMessage = teaEncode( n.message );		local encryptedMessage = teaEncode( n.message );

	logFile.writeShort( #encryptedMessage );		logFile:writeShort( #encryptedMessage );
	logFile.write( encryptedMessage );		logFile:write( encryptedMessage );

	-- Write date information.		-- Write date information.
	logFile.writeShort( n.time.second ); logFile.writeShort( n.time.minute ); logFile.writeShort( n.time.hour );		logFile:writeShort( n.time.second ); logFile:writeShort( n.time.minute ); logFile:writeShort( n.time.hour );
	logFile.writeShort( n.time.monthday ); logFile.writeShort( n.time.month + 1 ); logFile.writeShort( n.time.year + 1900 );		logFile:writeShort( n.time.monthday ); logFile:writeShort( n.time.month + 1 ); logFile:writeShort( n.time.year + 1900 );
	end		end
	end		end

The GTA: Created page with "NOTOC This function attempts to write a string of bytes (characters) into the file. It returns the amount of bytes that have actually been written. ==Syntax== ..."

2014-01-30T23:49:08Z

Created page with "__NOTOC__ This function attempts to write a string of bytes (characters) into the file. It returns the amount of bytes that have actually been written. ==Syntax== <syntaxhighlight lang="lua"> ..."

New page

__NOTOC__
This function attempts to write a string of bytes (characters) into the file. It returns the amount of bytes that have actually been written.

==Syntax==
<syntaxhighlight lang="lua">
int file.write ( string dataString )
</syntaxhighlight>

==Arguments==
*'''dataString:''' the string of data that should be written into the file

==Returns==
Returns the amount of bytes that have been actually written into the file. Returns false if '''dataString''' is not a valid string.

==Example==
<section name="Client" class="client" show="true">
This snippet logs the local player's chat output into a file.
<syntaxhighlight lang="lua">
-- Open up the logfile.
-- If it was not created already, create it.
local logFile = false;

if ( fileExists( "log.dat" ) ) then
logFile = fileOpen( "log.dat" );
else
logFile = fileCreate( "log.dat" );
end

-- Table of all log entries.
-- The logfile has to be written at the destruction of the resource environment.
-- This is done so we can have multiple log sessions added into a file stream.
local logEntries = {};

-- Function to append entries into the logfile.
local function addLogEntry( message )
local entry = {
message = message,
time = getRealTime()
};

table.insert( logEntries, entry );
end

-- Event handler to add log entries when chat messages are created.
addEventHandler( "onClientChatMessage", root,
function(message)
-- Forward the message into our logging system.
addLogEntry( message );
end
);

-- Write the log when the resource is terminated.
addEventHandler( "onClientResourceStop", root,
function()
-- todo: write session start and end times.

-- Write the amount of log entries.
logFile.writeShort( #logEntries );

-- Write the log entries.
for m,n in ipairs( logEntries ) do
local encryptedMessage = teaEncode( n.message );

logFile.writeShort( #encryptedMessage );
logFile.write( encryptedMessage );

-- Write date information.
logFile.writeShort( n.time.second ); logFile.writeShort( n.time.minute ); logFile.writeShort( n.time.hour );
logFile.writeShort( n.time.monthday ); logFile.writeShort( n.time.month + 1 ); logFile.writeShort( n.time.year + 1900 );
end
end
);

-- todo: create a log file viewer.
</syntaxhighlight>
</section>
{{:MTA:Eir/FileSystem/file/functions}}

MTA:Eir/FileSystem/file/write - Revision history

Quiret at 23:45, 16 January 2022

The GTA: Created page with "__NOTOC__ This function attempts to write a string of bytes (characters) into the file. It returns the amount of bytes that have actually been written. ==Syntax== ..."

The GTA: Created page with "NOTOC This function attempts to write a string of bytes (characters) into the file. It returns the amount of bytes that have actually been written. ==Syntax== ..."