Function Reference

Contents 1 Function Reference 1.1 Core Functions 1.1.1 Language Features 1.1.2 Console Functions 1.1.3 Variable Type Conversions 1.1.4 Common Variable Functions 1.1.5 Binary and Data Functions 1.1.6 Math Functions 1.1.7 String Functions 1.1.8 Array Functions 1.1.9 File Functions 1.1.9.1 Text File Create/Read/Write Functions 1.1.10 Misc Functions 1.2 User Defined Functions 1.2.1 Namespaces 1.2.1.1 Namespace Str -- Require("String.spk") 1.2.2 Classes

Function Reference

Core Functions

Language Features

• <Expression> =~ m/regex/
• <Expression> =~ s/regex/str/

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.
• Printf( <expression>, <expressions>... ) -- Print a formatted string to the console window
• 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

Binary and Data Functions

• Pack( <expression>, <expressions> ) -- Pack data into a binary array
• Unpack( <expression>, <binary-array> ) -- Unpack data from a binary array

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
• ATan( <expression> ) --
• BitAND( <expression> ) --
• BitNOT( <expression> ) --
• BitOR( <expression> ) --
• BitROTATE( <expression> ) --
• BitSHIFT( <expression> ) --
• BitXOR( <expression> ) --
• Ceiling( <expression> ) --
• Cos( <expression> ) --
• Cosh( <expression> ) --
• Exp( <expression> ) --
• Floor( <expression> ) --
• Log( <expression> ) --
• Math( <expression> ) --
• Max( <expression> ) --
• Min( <expression> ) --
• Mod( <expression> ) --
• Random( <expression> ) --
• Round( <expression> ) --
• Sin( <expression> ) --
• Sinh( <expression> ) --
• Sqrt( <expression> ) --
• Tan( <expression> ) --
• Tanh( <expression> ) --
• Turncate( <expression> ) --

String Functions

• Asc( <expression> ) --
• AscW( <expression> ) --
• Chr( <expression> ) --
• ChrW( <expression> ) --
• Contains( <expression> ) --
• Compare( <expression> ) --
• Dec( <expression> ) -- Returns a integer representation of a hexadecimal string
• FDec( <expression> ) -- Returns a float representation of a hexadecimal string
• DDec( <expression> ) -- Returns a double representation of a hexadecimal string
• EndsWith( <expression> ) --
• Hex( <expression>, <length> ) -- Returns a string representation of an integer type converted to hexadecimal
• FHex( <expression> ) -- Returns a string representation of an float type converted to hexadecimal
• DHex( <expression> ) -- Returns a string representation of an double type converted to hexadecimal
• InStr( <string>, <substirng>, <casesense>, <occurrence>, <start>, <count> ) -- Checks if a string contains a given substring.
• isAlpha( <expression> ) --
• isAlphaNumeric( <expression> ) --
• isASCII( <expression> ) --
• isFPU( <expression> ) --
• isLower( <expression> ) --
• isNumeric( <expression> ) --
• isSpace( <expression> ) --
• isSpace( <expression> ) --
• isUpper( <expression> ) --
• isXDigit( <expression> ) --
• LC( <expression> ) --
• LCFirst( <expression> ) --
• LCWords( <expression> ) --
• Left( <expression> ) --
• Match( <expression> ) --
• MD5( <expression> ) --
• PadLeft( <expression> ) --
• PadRight( <expression> ) --
• RandStr( <expression> ) --
• RegExp( <expression>, <pattern>, <flag>, <start> ) -- Check if a string fits a given regular expression pattern
• Replace( <expression> ) --
• Reverse( <expression> ) --
• Right( <expression> ) --
• SHA1( <expression> ) --
• Split( <expression>, <delim/pattern>, <flag> ) -- Splits up a string into substrings depending on the given delimiters.
• SPrintf( <expression>, <expressions>... ) -- Create a formatted string
• StartsWith( <expression> ) --
• StrLen( <expression> ) --
• SubStr( <expression> ) --
• Trim( <expression> ) --
• TrimLeft( <expression> ) --
• TrimRight( <expression> ) --
• UC( <expression> ) --
• UCFirst( <expression> ) --
• UCWords( <expression> ) --

Array Functions

• Join( <array>, <separator> ) -- Join an array into a string with an optional separator
• Splice( <array>, <expressions> ) -- Create a new array from an old one splicing it in specific ways
• UBound( <array> ) -- Returns the size of array (How many elements it currently has stored)

File Functions

Text File Create/Read/Write Functions

• FileOpen( <FileName>, <flag> ) -- 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
• FileAppend( <file>, <expression> ) -- Append a line of text to the end of a previously opened text file
• FileSeek( <file>, <offset>, <flag> ) -- 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 (Or specify a name of a file)
• FileReadLines( <file> ) -- Read all lines of text from a previously opened text file (Or specify a name of a file)
• FileSave( <file>, <expression> ) -- Save all text to a file
• FileLoad( <file> ) -- Load all text from a file

Misc Functions

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

User Defined Functions

This functions are either a Namepace or a Class.

These functions are created using Sputnik and are not part of the Sputnik core language.

Namespaces

Namespace Str -- Require("String.spk")

• str.StrToHex( <expression> ) -- Convert a string to a hex string
• str.HexToStr( <expression> ) -- Convert a hex string to a string

Classes