Function Reference

Revision as of 04:07, 9 November 2011 (view source) UberFoX (Talk | contribs) (→Math Functions) ← Older edit		Revision as of 08:48, 9 November 2011 (view source) UberFoX (Talk | contribs) (→Function Reference) Newer edit →
Line 38:		Line 38:
	* [[Core Function ACos|ACos( <expression> )]] -- Calculates the arcCosine of a number		* [[Core Function ACos|ACos( <expression> )]] -- Calculates the arcCosine of a number
	* [[Core Function ASin|ASin( <expression> )]] -- Calculates the arcsine of a number		* [[Core Function ASin|ASin( <expression> )]] -- Calculates the arcsine of a number
		+
		+	==== File Functions ====
		+	* [[Core Function FileOpen|FileOpen( <expression>, <expression>, <expression> )]] -- Opens a text file for reading or writing
		+	* [[Core Function FileClose|FileClose( <file> )]] -- Closes a previously opened file
		+	* [[Core Function FileWrite|FileWrite( <file>, <expression> )]] -- Write text to previously opened text file at the current File Steam pointer location
		+	* [[Core Function FileWriteLine|FileWriteLine( <file>, <expression> )]] -- Append a line of text to the end of a previously opened text file
		+	* [[Core Function FileSeek|FileSeek( <file>, <expression>, <expression> )]] -- Change the POSITION of the File Stream pointer
		+	* [[Core Function FilePOS|FilePOS( <file> )]] -- Get the current POSITION of the File Stream pointer
		+	* [[Core Function FileRead|FileRead( <file>, <expression> )]] -- Read a number of characters from a previously opened text file starting from current File Steam pointer location
		+	* [[Core Function FileReadLine|FileReadLine( <file>, <expression> )]] -- Read a line of text from a previously opened text file
	==== Misc Functions ====		==== Misc Functions ====

---

Revision as of 08:48, 9 November 2011

Contents 1 Function Reference 1.1 User Functions 1.2 Core Functions 1.2.1 Console Functions 1.2.2 Variable Type Conversions 1.2.3 Common Variable Functions 1.2.4 Math Functions 1.2.5 File Functions 1.2.6 Misc Functions

Function Reference

User Functions

Core Functions

Console Functions

• Print( <expression> ) -- Prints an expressions string value to the console window.
• Println( <expression> ) -- Prints an expressions string value to the console window and inserts a newline charactor at the end.
• Input( <expression> ) -- Capture a string typed to console window.
• InputC( <expression> ) -- Capture a char typed to console window.
• Cls( ) -- Clear all text from the console window.

Variable Type Conversions

• Byte( <expression> ) -- Returns the 8-bit integer (whole number) representation of an expression.
• Int16( <expression> ) -- Returns the 16-bit integer (whole number) representation of an expression.
• Int32( <expression> ) (Alias: Int( $variable )) -- Returns the 32-bit integer (whole number) representation of an expression.
• Int64( <expression> ) -- Returns the 64-bit integer (whole number) representation of an expression.

• Float( <expression> ) -- Returns the 32-bit floating point representation of an expression.
• Double( <expression> ) -- Returns the 64-bit floating point representation of an expression.
• String( <expression> ) -- Returns the String representation of an expression.

Common Variable Functions

• isInt( $variable ) -- Checks if a variable is an integer type
• isFloat( $variable ) -- Checks if a variable is a float-type
• isNumber( $variable ) -- Checks if a variable is a integer or float-type
• isString( $variable ) -- Checks if a variable is a string type
• isArray( $variable ) -- Check if a variable is an array
• isHash( $variable ) -- Check if a variable is an hash
• isObj( $variable ) -- Check if a variable is an object type
• isClass( $variable ) -- Check if a variable's object type is a class
• isStruct( $variable ) -- Check if a variable's object type is a struct

Math Functions

• Abs( <expression> ) -- Calculates the absolute value of a number
• ACos( <expression> ) -- Calculates the arcCosine of a number
• ASin( <expression> ) -- Calculates the arcsine of a number

File Functions

• FileOpen( <expression>, <expression>, <expression> ) -- Opens a text file for reading or writing
• FileClose( <file> ) -- Closes a previously opened file
• FileWrite( <file>, <expression> ) -- Write text to previously opened text file at the current File Steam pointer location
• FileWriteLine( <file>, <expression> ) -- Append a line of text to the end of a previously opened text file
• FileSeek( <file>, <expression>, <expression> ) -- Change the POSITION of the File Stream pointer
• FilePOS( <file> ) -- Get the current POSITION of the File Stream pointer
• FileRead( <file>, <expression> ) -- Read a number of characters from a previously opened text file starting from current File Steam pointer location
• FileReadLine( <file>, <expression> ) -- Read a line of text from a previously opened text file

Misc Functions

• Return( <expression> ) -- Returns a result from a Function.
• Require( <expression> ) -- Includes a file in the current script.