File System - Revision history

Outerbeast at 15:06, 20 April 2026

2026-04-20T15:06:39Z

← Older revision		Revision as of 17:06, 20 April 2026
Line 24:		Line 24:
	}		}

	pFile.Close(); // Close the file, if we are done.		pFile.Close(); // Close the file, if we are done. We don't want resource leaks.
	</pre>		</pre>
	=== Read/Write Restrictions ===		=== Read/Write Restrictions ===

Outerbeast at 10:51, 16 April 2025

2025-04-16T10:51:30Z

@@ Line 25: / Line 25: @@
 pFile.Close(); // Close the file, if we are done.
 </pre>
 === Methods ===

Outerbeast: /* Associated Global Functions */

2025-04-12T19:33:43Z

Associated Global Functions

← Older revision		Revision as of 21:33, 12 April 2025
Line 123:		Line 123:

	== Associated Global Functions ==		== Associated Global Functions ==
	These ~~function~~ exist in the <code>FileSystem</code> namespace.		These functions exist in the <code>FileSystem</code> namespace.

	{\| class="wikitable"		{\| class="wikitable"

Outerbeast at 16:54, 27 March 2025

2025-03-27T16:54:52Z

← Older revision		Revision as of 18:54, 27 March 2025
Line 139:		Line 139:
	\| style="vertical-align:middle;" \| Formats the open flags into a string that represents the flags.		\| style="vertical-align:middle;" \| Formats the open flags into a string that represents the flags.
	\|}		\|}
			[[Category:Scripting]]

Outerbeast at 16:52, 27 March 2025

2025-03-27T16:52:57Z

← Older revision		Revision as of 18:52, 27 March 2025
Line 1:		Line 1:
	The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files.		The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files.

			For security reasons, only the directory <code>scripts/maps/store/</code> or <code>scripts/plugins/store/</code> can be accessed.

	The <code>CVirtualFileSystem</code> class allows for opening and removing files. A single global instance exists: <code>CVirtualFileSystem g_FileSystem</code>		The <code>CVirtualFileSystem</code> class allows for opening and removing files. A single global instance exists: <code>CVirtualFileSystem g_FileSystem</code>

Outerbeast: Created page with "The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files. The `CVirtualFileS..."`


2025-03-27T16:47:03Z
Created page with "The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files.  The <code>CVirtualFileS..."
New page
The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files.



The <code>CVirtualFileSystem</code> class allows for opening and removing files. A single global instance exists: <code>CVirtualFileSystem g_FileSystem</code>



Opening a file is done as follows:



<pre>

OpenFileFlags_t uiOpenFlags = WRITE;

File@ pFile = g_FileSystem.OpenFile( "scripts/maps/store/<your filename>.<your extension>", uiOpenFlags );



if( pFile is null || !pFile.IsOpen() ) // File does not exist/couldn't open

    return;

// Read file line by line

while( !pFile.EOFReached() )

{

    string sCurrentLine;

    // Read the current line, store line content in sCurrentLine

    pFile.ReadLine( sCurrentLine );

    sCurrentLine.Trim();

    // Write to the file. OpenFileFlags_t uiOpenFlags must be set to WRITE

    pFile.Write( "Hello World!\n" );

}



pFile.Close(); // Close the file, if we are done.

</pre>

=== Methods ===

{| class="wikitable" 

|- style="font-weight:bold; text-align:center; vertical-align:middle;"

! CVirtualFileSystem method

! Description

|-

| <code>const FileQuota@ GetFileQuota() const

| style="vertical-align:middle;" | Gets the file system quota object. Do not store a handle to this object, as it may be replaced at any time.

|-

| <code>File@ OpenFile(const string& in szFilename, const OpenFileFlags_t uiOpenFlags)

| style="vertical-align:middle;" | Opens a file. Returns nullptr if the file could not be opened.

|-

| <code>void RemoveFile(const string& in szFilename)

| style="vertical-align:middle;" | Removes a file.

|}



=== OpenFile ===

These are values used for the <code>OpenFile</code> method and are of type <code>OpenFileFlags_t</code>.

They belong to the <code>OpenFile</code> enumeration.

{| class="wikitable" style="vertical-align:middle;"

|- style="font-weight:bold; text-align:center;"

! Name

! Value

! Description

|-

| READ

| 1

| Open file for reading.

|-

| WRITE

| 2

| Open file for writing.

|-

| APPEND

| 4

| Open file for appending.

|-

| BINARY

| 8

| Open in binary mode.

|}



== File ==

The <code>File</code> class represents an actual file object, which is returned by the CVirtualFileSystem method <code>OpenFile</code>.



{| class="wikitable" 

|- style="font-weight:bold; text-align:center; vertical-align:middle;"

! Declaration

! Description

|-

| <code>bool IsOpen() const

| style="vertical-align:middle;" | Returns whether the file was successfully opened.

|-

| <code>void Close()

| style="vertical-align:middle;" | Closes the file if it is open.

|-

| <code>void Remove()

| style="vertical-align:middle;" | Removes the file. The file must be open, and you must have write access.

|-

| <code>size_t GetSize() const

| style="vertical-align:middle;" | Returns the size of the file.

|-

| <code>size_t Tell() const

| style="vertical-align:middle;" | Tells the position of the read/write pointer.

|-

| <code>size_t Seek(const size_t uiPosition, const SeekFileFlags_t uiSeekMode)

| style="vertical-align:middle;" | Sets the read/write pointer to a new position. Returns the new position within the file.

|-

| <code>bool EOFReached() const

| style="vertical-align:middle;" | Returns whether end of file was reached.

|-

| <code>string ReadCharacter()

| style="vertical-align:middle;" | Reads a single character.

|-

| <code>void ReadLine(string& out szOutLine, const string& in szDelim = ' ')

| style="vertical-align:middle;" | Reads a line from the file.

|-

| <code>bool Read(BLOB@ pBlob, size_t uiSizeInBytes)

| style="vertical-align:middle;" | Reads a number of bytes into the given BLOB.

|-

| <code>bool Read(BLOB@ pBlob)

| style="vertical-align:middle;" | Reads as much as possible data into the given BLOB.

|-

| <code>BLOB@ ReadBlob(size_t uiSizeInBytes, bool fCanResize = true)

| style="vertical-align:middle;" | Reads a number of bytes into a BLOB.

|-

| <code>BLOB@ ReadBlob()

| style="vertical-align:middle;" | Reads as much as possible data into a BLOB.

|-

| <code>void Write(const string& in szString)

| style="vertical-align:middle;" | Writes a string to the file.

|-

| <code>void Write(const BLOB@ pBlob)

| style="vertical-align:middle;" | Writes a blob to the file.

|}



== Associated Global Functions ==

These function exist in the <code>FileSystem</code> namespace.



{| class="wikitable" 

|-

! Declaration

! Description

|-

| <code>bool FlagsValid(const OpenFileFlags_t uiOpenFlags)

| style="vertical-align:middle;" | Returns whether the given open flags are valid.

|-

| <code>OpenFileFlags_t FilterFlags(OpenFileFlags_t uiOpenFlags)

| style="vertical-align:middle;" | Filters the given flags, removing unnecessary flags.

|-

| <code>bool FormatOpenFlags(OpenFileFlags_t uiOpenFlags, string& out szOutFlags)

| style="vertical-align:middle;" | Formats the open flags into a string that represents the flags.

|}

File System - Revision history

Outerbeast at 15:06, 20 April 2026

Outerbeast at 10:51, 16 April 2025

Outerbeast: /* Associated Global Functions */

Outerbeast at 16:54, 27 March 2025

Outerbeast at 16:52, 27 March 2025

Outerbeast: Created page with "The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files. The CVirtualFileS..."

Outerbeast: Created page with "The virtual file system allows scripts to interact with files in the game's directory. It provides functions for reading, writing, and managing files. The `CVirtualFileS..."`