System Library - Revision history

Palota: CopyToClipboard

2026-04-24T15:40:33Z

CopyToClipboard

@@ Line 10: / Line 10: @@
 ==Global FileSystem Functions==
 ----
 ===FileDelete===
 Deletes a file by name. This function is restricted to files under the user folder.

Palota at 15:34, 24 April 2026

2026-04-24T15:34:31Z

← Older revision		Revision as of 15:34, 24 April 2026
Line 239:		Line 239:
	}		}
	f.Close();</syntaxhighlight>		f.Close();</syntaxhighlight>

			----

			===WriteLine===
			Write with a new line.

	----		----

Palota: /* Global FileSystem Functions */

2025-07-06T13:15:27Z

Global FileSystem Functions

← Older revision		Revision as of 13:15, 6 July 2025
Line 18:		Line 18:

	'''Example:''' <syntaxhighlight lang="java">		'''Example:''' <syntaxhighlight lang="java">
	FileDelete("myfile.txt");</syntaxhighlight>		System.FileDelete("myfile.txt");</syntaxhighlight>
	----		----

Line 32:		Line 32:
	{		{
	}		}
	FileEnumerate("myfolder", myfunc);</syntaxhighlight>		System.FileEnumerate("myfolder", myfunc);</syntaxhighlight>
	----		----
	===FileExists===		===FileExists===
Line 42:		Line 42:

	'''Example:''' <syntaxhighlight lang="java">		'''Example:''' <syntaxhighlight lang="java">
	if(FileExists("myfile.txt"))		if(System.FileExists("myfile.txt"))
	{		{
	}</syntaxhighlight>		}</syntaxhighlight>

Palota: /* Write */

2025-05-25T16:45:00Z

Write

← Older revision		Revision as of 16:45, 25 May 2025
Line 227:		Line 227:
	'''Parameters:''' (...)		'''Parameters:''' (...)

	This function can take any number of parameters, of types integer, float, string, or NewLine;		This function can take any number of parameters, of types integer, float, string, or System.NewLine.

	'''Returns:''' ~~none~~		'''Returns:''' true if successful, false if not

	'''Example:''' <syntaxhighlight lang="java">		'''Example:''' <syntaxhighlight lang="java">
Line 236:		Line 236:
	if(f.IsOpen())		if(f.IsOpen())
	{		{
	f.Write("Some test data", System.NewLine);		assert( f.Write("Some test data", System.NewLine) );
	}		}
	f.Close();</syntaxhighlight>		f.Close();</syntaxhighlight>
	----		----

Palota: 1 revision imported

2023-02-13T07:02:34Z

1 revision imported

← Older revision	Revision as of 07:02, 13 February 2023
(No difference)

Palota: 1 revision imported

2021-07-13T19:06:43Z

1 revision imported

New page

{{process header
| title = System Library
| section =
| previous = [[Omni-bot_Script_Reference | Script Reference]]
| next =
| shortcut =
| notes =
}}
{{TOCright}}
==Global FileSystem Functions==
----
===FileDelete===
Deletes a file by name. This function is restricted to files under the user folder.

'''Parameters:''' (filename)

'''Returns:''' true if success, false if failed

'''Example:''' <syntaxhighlight lang="java">
FileDelete("myfile.txt");</syntaxhighlight>
----

===FileEnumerate===
Enumerates over all files in a directory. This function is restricted to files under the user folder. This function will call the provided script function with all files enumerated.

'''Parameters:''' (folder name, script function)

'''Returns:''' true if success, false if failed

'''Example:''' <syntaxhighlight lang="java">
myfunc = function(filename)
{
}
FileEnumerate("myfolder", myfunc);</syntaxhighlight>
----
===FileExists===
Checks if a file exists by name. This function is restricted to files under the user folder.

'''Parameters:''' (filename)

'''Returns:''' true if exists, false if not

'''Example:''' <syntaxhighlight lang="java">
if(FileExists("myfile.txt"))
{
}</syntaxhighlight>
----
===Newline===
Returns a NewLine custom type. Used for writing newlines in text formatted files. It was a function in Omni-bot 0.71, but now it is a variable in Omni-bot 0.8.

'''Parameters:''' none

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
f = File();
f.Open("myfile.txt", "text", false);
if(f.IsOpen())
{
f.Write("Some test data", System.NewLine);
}
f.Close();</syntaxhighlight>
----

==File==
Creates a new File Object.

'''Parameters:''' none

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
f = File();</syntaxhighlight>

----
===Close===
Closes the file object and commits changes to disk.

'''Parameters:''' none

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
f.Close();</syntaxhighlight>

----

===EndOfFile===
Checks if the File Object is at the end of the file. Useful for read operations.

'''Parameters:''' none

'''Returns:''' true if end of file, false if not.

'''Example:''' <syntaxhighlight lang="java">
eof = f.EndOfFile();</syntaxhighlight>

----

===FileSize===
Gets the file size of the file, in bytes.

'''Parameters:''' none

'''Returns:''' size of file in bytes

'''Example:''' <syntaxhighlight lang="java">
size = f.FileSize();</syntaxhighlight>

----

===Flush===
Flushes the file buffer to disk.

'''Parameters:''' none

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
f.Flush();</syntaxhighlight>

----

===IsOpen===
Checks if the file is currently open. Usually used after a call to Open.

'''Parameters:''' none

'''Returns:''' true if file is open, false if not

'''Example:''' <syntaxhighlight lang="java">
if(f.IsOpen())
{
}</syntaxhighlight>

----

===Open===
Creates a new File Object.

'''Parameters:''' (filename, "text"/"binary", readonly<optional>, append<optional>)

'''Returns:''' true if success, false if failed.

'''Example:''' <syntaxhighlight lang="java">
if(f.Open("myfile.txt", "text", false))
{
}</syntaxhighlight>

----

===ReadFloat===
Reads a float from the file.

'''Parameters:''' none

'''Returns:''' float read, or null if there was an error

'''Example:''' <syntaxhighlight lang="java">
num = f.ReadFloat();</syntaxhighlight>

----

===ReadInt===
Reads an integer from the file.

'''Parameters:''' none

'''Returns:''' integer read, or null if there was an error

'''Example:''' <syntaxhighlight lang="java">
num = f.ReadInt();</syntaxhighlight>

----

===ReadLine===
Reads a string from a file until a newline or end of file is encountered.

'''Parameters:''' none

'''Returns:''' string read, or null if there was an error

'''Example:''' <syntaxhighlight lang="java">
str = f.ReadLine();</syntaxhighlight>

----

===ReadString===
Reads a string from a file.

'''Parameters:''' none

'''Returns:''' string read, or null if there was an error

'''Example:''' <syntaxhighlight lang="java">
str = f.ReadString();</syntaxhighlight>

----

===Seek===
Seeks the read/write position to a specified offset.

'''Parameters:''' (byte offset to seek to)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
f.Seek(100); // seek 100 bytes into file</syntaxhighlight>

----

===Tell===
Returns the current offset of the read/write position in the file.

'''Parameters:''' none

'''Returns:''' byte position in file

'''Example:''' <syntaxhighlight lang="java">
t = f.Tell();</syntaxhighlight>

----

===Write===
Writes a value of varying types to the file, in whatever file mode was used to open the file.

'''Parameters:''' (...)

This function can take any number of parameters, of types integer, float, string, or NewLine;

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
f = File();
f.Open("myfile.txt", "text", false);
if(f.IsOpen())
{
f.Write("Some test data", System.NewLine);
}
f.Close();</syntaxhighlight>
----