Sputnik Wiki - User contributions [en-gb]

Core Function Goto Label

2011-12-11T17:24:22Z

Alexpja:

<pre>
Goto Label; & Label:
</pre>

=== Description ===

Jump to another section of the script

=== Remarks ===

This is not a universal *jump to anything you can see* it can only jump through local scopes and what not.

Think of it as a kind of multilayer break statement.

Note - People often avoid using "goto" statements in languages because they tend to be slow and a very poor way of solving a problem yet its here if you want it.

If a label cannot be found an exception will occur.

=== Example ===

<syntaxhighlight lang="sputnik">
goto Begin;

Above:
println( "Hello Above" );
goto Below;

Begin:
println( "Hello" );
goto Above;

Below:
println( "Hello Below" );
</syntaxhighlight>

[[Category:Core Function]]

Core Function MySQLConnect

2011-12-11T06:32:59Z

Alexpja: /* Remarks */

<pre>
MySQLConnect( <ip/ip:port>, <login>, <password> )
</pre>

=== Description ===

Connect to a MySQL database.

=== Parameters ===

==== ip/ip:port ====

The IP example "127.0.0.1"

OR

The IP and port example "127.0.0.1:3016"

==== login ====

The MySQL login to use for the connection.

==== password ====

The MySQL password to use for the connection.

=== Return Value ===

Success: Returns the MySQL object.

Failure: Returns 0.

=== Remarks ===

Sputnik includes an easy to use built-in MySQL support since I use SQL a lot in my scripts.

=== Example ===

<syntaxhighlight lang="sputnik">
$CONN = MySQLConnect("127.0.0.1", "root", "777");
If($CONN)
{
println("Connected...");
If(MySQLSelectDB($CONN, "sp2"))
{
//MySQLQuery("UPDATE bla bla bla....");
//MySQLQuery("INSERT bla bla bla....");
println("Selected db...");
$Data = MySQLFill($CONN, "SELECT * FROM players");
If($Data)
{
println("Got data...");
$Fields = MySQLFields($Data);
$Rows = MySQLRows($Data);
println("Data has '$Fields' Field(s) and '$Rows' Row(s)...");
While( $Row = MySQLFetch($Data) )
{
$Name = $Row["Name"];
$Pass = $Row["Pass"];
println("Name '$Name' Pass '$Pass'");
}
//MySQLFetchReset($Data); //Uncomment if you wish to loop through this table again
}
Else
{
println("Failed to get data...");
}
MySQLClose($CONN);
}
Else
{
println("Failed to select db...");
}
}
Else
{
println("Failed to connect...");
}
</syntaxhighlight>

[[Category:Core Function]]

Function Reference

2011-12-09T23:31:36Z

Alexpja: /* Process Functions */

== Function Reference ==

=== How to create a Function ===

To create your own funtions see the Function page.

* [[User Function|User Defined Functions]]

=== Core Functions ===

==== Language Features ====

* [[Core Function Regex Match|<Expression> =~ m/pattern/flags]] -- Match a string to a regular expression pattern and check if it matches and optionally return captured groups
* [[Core Function Regex Replace|<Expression> =~ s/pattern/replacement/flags]] -- Replace parts of a string using a regular expression pattern and optionally executing functions on the matched groups
* [[Core Function Goto Label|Goto Label; & Label:]] -- Jump to another section of the script

==== Console Functions ====
* [[Core Function Print|Print( <expression> )]] -- Prints an expressions string value to the console window
* [[Core Function Println|Println( <expression> )]] -- Prints an expressions string value to the console window and inserts a newline charactor at the end.
* [[Core Function Printf|Printf( <expression>, <expressions>... )]] -- Print a formatted string to the console window
* [[Core Function Input|Input( <expression> )]] -- Capture a string typed to console window
* [[Core Function InputC|InputC( <expression> )]] -- Capture a char typed to console window
* [[Core Function Cls|Cls( )]] -- Clear all text from the console window
* [[Core Function ConsoleHide|ConsoleHide( )]] -- Hide the console window
* [[Core Function ConsoleShow|ConsoleShow( )]] -- Show the console window
* [[Core Function ConsoleBeep|ConsoleBeep( <freq>, <duration> )]] -- Plays the sound of a beep of a specified frequency and duration through the console speaker
* [[Core Function ConsoleSeek|ConsoleSeek( <x>, <y> )]] -- Set the position of the console cursor
* [[Core Function ConsoleBackColour|ConsoleBackColour( <colour> )]] -- Set the background (behind text) colour of the console
* [[Core Function ConsoleForeColour|ConsoleForeColour( <colour> )]] -- Set the foreground (text) colour of the console
* [[Core Function ConsoleBufferWidth|ConsoleBufferWidth( <newval> )]] -- Get or Set the buffer width of the console window
* [[Core Function ConsoleBufferHeight|ConsoleBufferHeight( <newval> )]] -- Get or Set the buffer height of the console window
* [[Core Function ConsoleWidth|ConsoleWidth( <newval> )]] -- Get or Set the width of the console window
* [[Core Function ConsoleHeight|ConsoleHeight( <newval> )]] -- Get or Set the height of the console window
* [[Core Function ConsoleTitle|ConsoleTitle( <newtitle> )]] -- Get or Set the title of the console window
* [[Core Function ConsoleCursorLeft|ConsoleCursorLeft( <newval> )]] -- Gets or sets the column position of the cursor within the buffer area
* [[Core Function ConsoleCursorTop|ConsoleCursorTop( <newval> )]] -- Gets or sets the row position of the cursor within the buffer area
* [[Core Function ConsoleCursorSize|ConsoleCursorSize( <newval> )]] -- Gets or sets the height of the cursor within a character cell
* [[Core Function ConsoleCursorVisible|ConsoleCursorVisible( <newval> )]] -- Gets or sets a value indicating whether the cursor is visible

==== Multi-Threading Functions ====

* [[Core Function ThreadCreate|ThreadCreate( <name>, <function> )]] -- Create a new thread and start it off executing a function or some code
* [[Core Function ThreadSleep|ThreadSleep( <name> )]] -- Freeze a thread and make it sleep
* [[Core Function ThreadResume|ThreadResume( <name> )]] -- Unfreeze a thread and allow it to continue execution
* [[Core Function ThreadState|ThreadState( <name> )]] -- Returns state of a thread
* [[Core Function ThreadKill|ThreadKill( <name> )]] -- Terminate a thread and remove it from the script
* [[Core Function ThreadExists|ThreadExists( <name> )]] -- Check if a thread exists by this name
* [[Core Function ThreadName|ThreadName( )]] -- Returns the name of the current thread that is executing this code
* [[Core Function Threads|Threads( )]] -- Return an array of all threads

==== Variable Type Conversions ====

* [[Core Function Char|Char( <expression> )]] -- Returns the single letter representation of an expression
* [[Core Function Byte|Byte( <expression> )]] -- Returns the unsigned 8-bit integer (whole number) representation of an expression
* [[Core Function SByte|SByte( <expression> )]] -- Returns the signed 8-bit integer (whole number) representation of an expression
* [[Core Function Short|Short( <expression> )]] -- Returns the signed 16-bit integer (whole number) representation of an expression
* [[Core Function Int16|Int16( <expression> )]] -- Returns the signed 16-bit integer (whole number) representation of an expression
* [[Core Function Int32|Int32( <expression> )]] -- Returns the signed 32-bit integer (whole number) representation of an expression
* [[Core Function Int|Int( <expression> )]] -- Returns the signed 32-bit integer (whole number) representation of an expression
* [[Core Function Int64|Int64( <expression> )]] -- Returns the signed 64-bit integer (whole number) representation of an expression
* [[Core Function Long|Long( <expression> )]] -- Returns the signed 64-bit integer (whole number) representation of an expression
* [[Core Function UShort|UShort( <expression> )]] -- Returns the unsigned 16-bit integer (whole number) representation of an expression
* [[Core Function UInt16|UInt16( <expression> )]] -- Returns the unsigned 16-bit integer (whole number) representation of an expression
* [[Core Function UInt32|UInt32( <expression> )]] -- Returns the unsigned 32-bit integer (whole number) representation of an expression
* [[Core Function UInt|UInt( <expression> )]] -- Returns the unsigned 32-bit integer (whole number) representation of an expression
* [[Core Function UInt64|UInt64( <expression> )]] -- Returns the unsigned 64-bit integer (whole number) representation of an expression
* [[Core Function ULong|ULong( <expression> )]] -- Returns the unsigned 64-bit integer (whole number) representation of an expression
* [[Core Function Float|Float( <expression> )]] -- Returns the 32-bit floating point representation of an expression
* [[Core Function Double|Double( <expression> )]] -- Returns the 64-bit floating point representation of an expression
* [[Core Function String|String( <expression> )]] -- Returns the String representation of an expression

==== Common Variable Functions ====

===== Misc =====
* [[Core Function Unset|Unset( $variable )]] -- Delete a variable
* [[Core Function IsDeclared|IsDeclared( <variable name> )]] -- Check if a variable has been declared

===== Hash/Array =====
* [[Core Function Reset|Reset( $variable )]] -- Reset the current array pointer to the first element
* [[Core Function Next|Next( $variable )]] -- Set the array pointer to the next element
* [[Core Function Prev|Prev( $variable )]] -- Set the array pointer to the previous element

===== Type Checking =====

* [[Core Function isVarChar|isVarChar( $variable )]] -- Checks if a variable is a char type
* [[Core Function isVarByte|isVarByte( $variable )]] -- Checks if a variable is an unsigned 8-bit integer type
* [[Core Function isVarSByte|isVarSByte( $variable )]] -- Checks if a variable is a signed 8-bit integer type
* [[Core Function isVarShort|isVarShort( $variable )]] -- Checks if a variable is a signed 16-bit integer type
* [[Core Function isVarInt16|isVarInt16( $variable )]] -- Checks if a variable is a signed 16-bit integer type
* [[Core Function isVarInt|isVarInt( $variable )]] -- Checks if a variable is a signed 32-bit integer type
* [[Core Function isVarInt32|isVarInt32( $variable )]] -- Checks if a variable is a signed 32-bit integer type
* [[Core Function isVarInt64|isVarInt64( $variable )]] -- Checks if a variable is a signed 64-bit integer type
* [[Core Function isVarLong|isVarLong( $variable )]] -- Checks if a variable is a signed 64-bit integer type
* [[Core Function isVarUShort|isVarUShort( $variable )]] -- Checks if a variable is an unsigned 16-bit integer type
* [[Core Function isVarUInt16|isVarUInt16( $variable )]] -- Checks if a variable is an unsigned 16-bit integer type
* [[Core Function isVarUInt|isVarUInt( $variable )]] -- Checks if a variable is an unsigned 32-bit integer type
* [[Core Function isVarUInt32|isVarUInt32( $variable )]] -- Checks if a variable is an unsigned 32-bit integer type
* [[Core Function isVarUInt64|isVarUInt64( $variable )]] -- Checks if a variable is an unsigned 64-bit integer type
* [[Core Function isVarULong|isVarULong( $variable )]] -- Checks if a variable is an unsigned 64-bit integer type
* [[Core Function isVarFloat|isVarFloat( $variable )]] -- Checks if a variable is a single precision floating point type
* [[Core Function isVarDouble|isVarDouble( $variable )]] -- Checks if a variable is a double precision floating point type
* [[Core Function isVarString|isVarString( $variable )]] -- Checks if a variable is a string type
* [[Core Function isVarNumber|isVarNumber( $variable )]] -- Checks if a variable is any integer or float/double type
* [[Core Function isVarBinary|isVarBinary( $variable )]] -- Checks if a variable is a binary type
* [[Core Function isVarRef|isVarRef( $variable )]] -- Check if a variable is an reference to another variable
* [[Core Function isVarArray|isVarArray( $variable )]] -- Check if a variable is an array
* [[Core Function isVarObj|isVarObj( $variable, <type> )]] -- Check if a variable is an object type (This includes classes, file handles etc)
* [[Core Function isVarClass|isVarClass( $variable, <type> )]] -- Check if a variable's object type is a class
* [[Core Function isVarGUI|isVarGUI( $variable )]] -- Check if a variable's object type is a GUI
* [[Core Function isVarGUIObject|isVarGUIObject( $variable, <type> )]] -- Check if a variable's object type is a GUI Object (Buttons etc)
* [[Core Function isVarDLLStruct|isVarDLLStruct( $variable )]] -- Check if a variable holds a DLLStruct
* [[Core Function isVarServer|isVarServer( $variable )]] -- Check if a variable holds a Server object from Listen()
* [[Core Function isVarClient|isVarClient( $variable )]] -- Check if a variable holds a Client object from Connect()
* [[Core Function isVarClientSocket|isVarClientSocket( $variable )]] -- Check if a variable holds a Client socket object

====== Get Type Directly ======
* [[Core Function GetVarType|GetVarType( $variable )]] -- Get the common type of a variable
* [[Core Function GetVarObjType|GetVarObjType( $variable )]] -- Get the common object type of a variable (If it is an object)
* [[Core Function GetVarGUIObjType|GetVarGUIObjType( $variable )]] -- Get the common object type of a variable (If it is a GUI object)

==== Binary Data Management Functions ====
* [[Core Function Pack|Pack( <expression>, <expressions> )]] -- Pack data into a binary array
* [[Core Function Unpack|Unpack( <expression>, <binary-array> )]] -- Unpack data from a binary array
* [[Core Function BinaryCreate|BinaryCreate( <size>, <fill> )]] -- Create a new binary variable and its array size and fill data type
* [[Core Function BinaryClone|BinaryClone( <binary-array> )]] -- Clone a binary variable 100% and return a new binary variable with exactly same data as the old one
* [[Core Function BinaryWipe|BinaryWipe( <binary-array> )]] -- Wipes a binary variables data 100% and sets the variable to a blank int containing just 0
* [[Core Function BinaryStr|BinaryStr( <binary-array>, <separator> )]] -- Create a Hex string from a binary array
* [[Core Function BinaryHex|BinaryHex( <expression> )]] -- Create a binary array from a hex string
* [[Core Function BinaryLen|BinaryLen( <binary-array> )]] -- Returns the number of bytes in a binary variable
* [[Core Function BinaryGet|BinaryGet( <binary-array>, <index> )]] -- Get the byte at an index of a binary variable
* [[Core Function BinarySet|BinarySet( <binary-array>, <index>, <value> )]] -- Set the byte at an index of a binary variable
* [[Core Function BinaryReverse|BinaryReverse( <binary-array>, <start>, <length> )]] -- Reverse the order bytes a binary variable
* [[Core Function BinaryMid|BinaryMid( <binary-array>, <start>, <length> )]] -- Create a binary variable by extracting a number of bytes from another binary variable
* [[Core Function BinaryAppend|BinaryAppend( <binary-array>, <binary-array2>, <flag> )]] -- Append a binary variables data onto the end or beginning of another binary variables data
* [[Core Function BinaryInsert|BinaryInsert( <binary-array>, <binary-array2>, <index> )]] -- Insert a binary variables data into another binary variable at a specific location
* [[Core Function BinaryUnshift|BinaryUnshift( <binary-array>, <byte> )]] -- Add a byte to the beginning of a binary variable
* [[Core Function BinaryPush|BinaryPush( <binary-array>, <byte> )]] -- Add a byte to the end of a binary variable
* [[Core Function BinaryShift|BinaryShift( <binary-array> )]] -- Delete the first byte from a binary variable
* [[Core Function BinaryPop|BinaryPop( <binary-array> )]] -- Delete the last byte from a binary variable
* [[Core Function BinaryResize|BinaryResize( <binary-array>, <size>, <data> )]] -- Resize a binary variables data array
* [[Core Function BinaryCompress|BinaryCompress( <binary-array> )]] -- Compress a binary variables data
* [[Core Function BinaryUncompress|BinaryUncompress( <binary-array> )]] -- Uncompress a binary variable data
* [[Core Function BinarySave|BinarySave( <binary-array>, <file>, <flag> )]] -- Save a binary variable data to file
* [[Core Function BinaryLoad|BinaryLoad( <file>, <flag> )]] -- Create a new binary variable by loading binary data from a file

==== Math Functions ====
* [[Core Function Abs|Abs( <expression> )]] -- Calculates the absolute value 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 ATan|ATan( <expression> )]] -- Calculates the arctangent of a number
* [[Core Function ATan2|ATan2( <expression>, <expression2> )]] -- Compute arc tangent with two parameters
* [[Core Function BitAND|BitAND( <expression>, <expression2>, <n> )]] -- Performs a bitwise AND operation
* [[Core Function BitNOT|BitNOT( <expression> )]] -- Performs a bitwise NOT operation
* [[Core Function BitOR|BitOR( <expression>, <expression2>, <n> )]] -- Performs a bitwise OR operation
* [[Core Function BitSHIFT|BitSHIFT( <value>, <shift> )]] -- Performs a bit shifting operation
* [[Core Function BitXOR|BitXOR( <expression>, <expression2>, <n> )]] -- Performs a bitwise exclusive OR (XOR) operation
* [[Core Function Ceiling|Ceiling( <expression> )]] -- Returns a number rounded up to the next integer
* [[Core Function Cos|Cos( <expression> )]] -- Calculates the cosine of a number
* [[Core Function Cosh|Cosh( <expression> )]] -- Returns the hyperbolic cosine of the specified angle
* [[Core Function Exp|Exp( <expression> )]] -- Returns e raised to the specified power
* [[Core Function Floor|Floor( <expression> )]] -- Returns the largest integer less than or equal to the specified number
* [[Core Function Log|Log( <expression> )]] -- Returns the logarithm of a specified number
* [[Core Function Log10|Log10( <expression> )]] -- Returns the common (base-10) logarithm of a specified number
* [[Core Function Math|Math( <expression> )]] -- Parse a string containing mathematical equations
* [[Core Function Max|Max( <expression>, <expression2> )]] -- Find the greater number and return it
* [[Core Function Min|Min( <expression>, <expression2> )]] -- Find the lesser number and return it
* [[Core Function Mod|Mod( <expression>, <expression2> )]] -- Performs the modulus operation
* [[Core Function Pow|Pow( <expression>, <expression2> )]] -- Returns a specified number raised to the specified power
* [[Core Function Random|Random( <expression>, <expression2> )]] -- Get a random number from the defined area.
* [[Core Function Round|Round( <expression>, <decimalplaces> )]] -- Returns a number rounded to a specified number of decimal places
* [[Core Function Sin|Sin( <expression> )]] -- Returns the sine of the specified angle
* [[Core Function Sinh|Sinh( <expression> )]] -- Returns the hyperbolic sine of the specified angle
* [[Core Function Sqrt|Sqrt( <expression> )]] -- Returns the square root of a specified number
* [[Core Function Tan|Tan( <expression> )]] -- Returns the tangent of the specified angle
* [[Core Function Tanh|Tanh( <expression> )]] -- Returns the hyperbolic tangent of the specified angle
* [[Core Function Truncate|Truncate( <expression> )]] -- Calculates the integral part of a specified decimal number

==== String Functions ====
* [[Core Function Asc|Asc( <char> )]] -- Returns the ASCII code of a character.
* [[Core Function AscW|AscW( <char> )]] -- Returns the UNICODE code of a character.
* [[Core Function Chr|Chr( <expression> )]] -- Returns a character corresponding to an ASCII code.
* [[Core Function ChrW|ChrW( <expression> )]] -- Returns a character corresponding to a UNICODE code.
* [[Core Function Contains|Contains( <srting>, <string>, <casesense>)]] -- Check if string contains a sub string
* [[Core Function CSV|CSV( <string>, <delim>, <quote>, <comment> )]] -- Split strings and parse a CSV text into an array
* [[Core Function Dec|Dec( <expression> )]] -- Returns a integer representation of a hexadecimal string
* [[Core Function FDec|FDec( <expression> )]] -- Returns a float representation of a hexadecimal string
* [[Core Function DDec|DDec( <expression> )]] -- Returns a double representation of a hexadecimal string
* [[Core Function DecPad|DecPad( <expression>, <count> )]] -- Pads numeric string to a given number of chars (Filling in the gap with zeros)
* [[Core Function DecryptString|DecryptString( <expression>, <password> )]] -- Decrypt a string with a given password
* [[Core Function EncryptString|EncryptString( <expression>, <password> )]] -- Encrypt a string with a given password
* [[Core Function EndsWith|EndsWith( <expression>, <expression2>, <flag> )]] -- Check if a string ends with a substring
* [[Core Function Hex|Hex( <expression>, <length> )]] -- Returns a string representation of an integer type converted to hexadecimal
* [[Core Function FHex|FHex( <expression> )]] -- Returns a string representation of an float type converted to hexadecimal
* [[Core Function DHex|DHex( <expression> )]] -- Returns a string representation of an double type converted to hexadecimal
* [[Core Function InStr|InStr( <string>, <substirng>, <casesense>, <occurrence>, <start>, <count> )]] -- Checks if a string contains a given substring.
* [[Core Function isAlpha|isAlpha( <expression> )]] -- Checks if string contains only Alphabetic characters
* [[Core Function isAlphaNumeric|isAlphaNumeric( <expression> )]] -- Checks if string contains only AlphaNumeric(A-Z, 0-9), Characters
* [[Core Function isASCII|isASCII( <expression> )]] -- Check if string contains only ASCII chars
* [[Core Function isEmpty|isEmpty( <expression> )]] -- Checks if a string is completely empty.
* [[Core Function isFloat|isFloat( <expression> )]] -- Check if string contains a floating point and could be converted
* [[Core Function isLower|isLower( <expression> )]] -- Checks if string contains only lowercase letters
* [[Core Function isNumeric|isNumeric( <expression> )]] -- Checks if string only contains numbers
* [[Core Function isSpace|isSpace( <expression> )]] -- Check if string contains only whitespace
* [[Core Function isSymbol|isSymbol( <expression> )]] -- Check if string contains only symbol chars
* [[Core Function isUpper|isUpper( <expression> )]] -- Check if string contains only uppercase chars
* [[Core Function isXDigit|isXDigit( <expression> )]] -- Check if string contains only hex chars
* [[Core Function LC|LC( <expression> )]] -- Returns string in all lower case
* [[Core Function LCFirst|LCFirst( <expression> )]] -- Lower Cases first letter of string
* [[Core Function LCLast|LCLast( <expression> )]] -- Lower Cases last letter of string
* [[Core Function LCWords|LCWords( <expression> )]] -- Lower Cases first letter of each word in string
* [[Core Function Left|Left( <expression>, <count> )]] -- Returns a number of characters from the left-hand side of a string
* [[Core Function Match|Match( <expression>, <charset> )]] -- Check if a string contains only characters from a substring
* [[Core Function MD5|MD5( <expression> )]] -- Creates MD5 Hash of specified string
* [[Core Function PadLeft|PadLeft( <expression>, <pad>, <count> )]] -- Pad the left of a string a given number of times with another string
* [[Core Function PadRight|PadRight( <expression>, <pad>, <count> )]] -- Pad the right of a string a given number of times with another string
* [[Core Function RandStr|RandStr( <count> )]] -- Generate a random sequence of characters at a given length
* [[Core Function Repeat|Repeat( <expression>, <count>, <flag> )]] -- Create a new string or new array containing repeats of a string provided
* [[Core Function Replace|Replace( <expression>, <find>, <replace>, <case-sensitive-flag> )]] -- Replace substrings within a string with other strings
* [[Core Function Reverse|Reverse( <expression> )]] -- Reverse all characters in a string
* [[Core Function Right|Right( <expression>, <count> )]] -- Returns a number of characters from the right-hand side of a string
* [[Core Function SHA1|SHA1( <expression> )]] -- Returns SHA1 hash of string
* [[Core Function Split|Split( <expression>, <delim/pattern>, <flag> )]] -- Splits up a string into substrings depending on the given delimiters.
* [[Core Function SPrintf|SPrintf( <expression>, <expressions>... )]] -- Create a formatted string
* [[Core Function StartsWith|StartsWith( <expression>, <expression2>, <flag> )]] -- Check if a string starts with a substring
* [[Core Function StrInsert|StrInsert( <expression>, <index>, <expression2> )]] -- Insert a string at a given index of another string and return the new string
* [[Core Function StrIndex|StrIndex( <expression>, <index> )]] -- Get or set a char from/to a string at a specific index
* [[Core Function StrLen|StrLen( <expression> )]] -- Returns length of specified string
* [[Core Function SubStr|SubStr( <expression>, <start>, <end> )]] -- Return part of a string
* [[Core Function Trim|Trim( <expression>, <chars> )]] -- Removes whitespace from the beginning and end of a string
* [[Core Function TrimLeft|TrimLeft( <expression>, <chars> )]] -- Strip whitespace from the start of a string
* [[Core Function TrimRight|TrimRight( <expression>, <chars> )]] -- Strip whitespace from the end of a string
* [[Core Function UC|UC( <expression> )]] -- Returns string in all Upper Case
* [[Core Function UCFirst|UCFirst( <expression> )]] -- Upper Cases first letter of string
* [[Core Function UCLast|UCLast( <expression> )]] -- Upper Cases last letter of string
* [[Core Function UCWords|UCWords( <expression> )]] -- Upper Cases first letter of each word in string

==== Array Functions ====
* [[Core Function Join|Join( <array>, <separator> )]] -- Join an array into a string with an optional separator
* [[Core Function UBound|UBound( <array/binary-array> )]] -- Returns the size of array (How many elements it currently has stored)
* [[Core Function Push|Push( <array>, <expressions> )]] -- Add items to the end of an array
* [[Core Function Insert|Insert( <array>, <id>, <expressions> )]] -- Add items to an array at a given location
* [[Core Function Unshift|Unshift( <array>, <expressions> )]] -- Add items to the beginning of an array
* [[Core Function Pop|Pop( <array> )]] -- Delete the first item in an array
* [[Core Function Shift|Shift( <array> )]] -- Delete the last item in an array
* [[Core Function Remove|Remove( <array>, <start-id>, <end-id> )]] -- Delete items from an array starting at a given location and stopping at a given location
* [[Core Function IsIndexSet|IsIndexSet( <array>, <index> )]] -- Check if an element exist at a given index ID within an array

==== Hash (Dictionary) Functions ====
* [[Core Function Each|Each( <array> )]] -- Get hash key/value pair and return them as a 2 element array and each time the function is called get the next key/value pair
* [[Core Function IsKeySet|IsKeySet( <array>, <key> )]] -- Check if given key exists within an array (hash/dictionary)

==== Process Functions ====
* [[Core Function DLLCall|DLLCall( <dll>, <function>, <returntype>, <paramtypes>, <params> )]] -- Dynamically call a function in a DLL
* [[Core Function DLLStructCreateDef|DLLStructCreateDef( <name>, <def string> )]] -- Creates a named C/C++ style structure definition that can be used with DLLStructCreate and can also be placed inside other DLLStructs
* [[Core Function DLLStructCreate|DLLStructCreate( <def string> )]] -- Creates a C/C++ style structure to be used with DLLCall
* [[Core Function DLLStructGetData|DLLStructGetData( <dllstruct>, <element>, <index> )]] -- Returns the data of an element of the struct
* [[Core Function DLLStructSetData|DLLStructSetData( <dllstruct>, <element>, <index> )]] -- Set the data of an element of the struct
* [[Core Function DllStructGetSize|DLLStructGetSize( <dllstruct> )]] -- Returns the size of the struct in bytes
* [[Core Function DllStructGetPtr|DLLStructGetPtr( <dllstruct>, <element>, <index> )]] -- Returns the pointer to the struct or an element in the struct or even a specific index of an array object within an elment
* [[Core Function DllStructGetVars|DLLStructGetVars( <dllstruct> )]] -- Create an array of all items and their array size with total byte size
* [[Core Function LoadAssembly|LoadAssembly( <file> )]] -- Load a .NET DLL into a variable
* [[Core Function UnloadAssembly|UnloadAssembly( <assembly> )]] -- Unload a .NET DLL from a variable
* [[Core Function GetMethod|GetMethod( <assembly>, <namespace>, <class>, <method>, <paramdefs>, <params> )]] -- Load an instance of a method and its container class into a variable to be able to call it
* [[Core Function Invoke|Invoke( <method>, <params> )]] -- Call the function obtained from GetMethod()
* [[Core Function Run|Run( <file>, <arguments>, <workdir>, <flag>, <show options> )]] -- Runs an external program
* [[Core Function RunWait|RunWait( <file>, <timeout>, <arguments>, <workdir>, <flag>, <show options> )]] -- Runs an external program and waits until the program finishes
* [[Core Function RunAsSet|RunAsSet( <user>, <domain>, <password>, <options> )]] -- Initialise a set of user credentials to use during Run and RunWait operations.
* [[Core Function ProcessClose|ProcessClose( <pid/name> )]] -- Terminates a named process
* [[Core Function ProcessExists|ProcessExists( <pid/name> )]] -- Checks to see if a specified process exists
* [[Core Function ProcessList|ProcessList( <name> )]] -- Returns an array listing the currently running processes (names and PIDs)
* [[Core Function ProcessSetPriority|ProcessSetPriority( <pid/name>, <priority> )]] -- Changes the priority of a process
* [[Core Function ProcessWait|ProcessWait( <pid/name>, <timeout> )]] -- Pauses the current thread until a given process exists or optional the timeout expires
* [[Core Function ProcessWaitClose|ProcessWaitClose( <pid/name>, <timeout> )]] -- Pauses the current thread until a given process no longer exists or optional the timeout expires
* [[Core Function Shutdown|Shutdown( <shutdown code> )]] -- Shuts down the system
* [[Core Function Debug|Debug( <flag> )]] -- Enter or leave debug mode in debug state the program can interact with operating system processes that run in a special mode by enabling the native property SeDebugPrivilege on the current thread

==== Environment Management ====
* [[Core Function EnvExpand|EnvExpand( <expression> )]] -- Convert a string containing %name% env tags and return complete string with names resolved
* [[Core Function EnvGet|EnvGet( <tag> )]] -- Get the value of an environment variable
* [[Core Function EnvSet|EnvSet( <tag>, <expression> )]] -- Set the value of an environment variable
* [[Core Function EnvUpdate|EnvUpdate( )]] -- Refreshes the OS environment

==== File Functions ====

===== File Create/Read/Write Functions =====
* [[Core Function FileOpen|FileOpen( <FileName>, <flag> )]] -- Opens a 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 file at the current File Steam pointer location
* [[Core Function FileWriteBinary|FileWriteBinary( <file>, <binary-array> )]] -- Write the data from a binary variable to previously opened file at the current File Steam pointer location
* [[Core Function FileAppend|FileAppend( <file>, <expression> )]] -- Append a line of text to the end of a previously opened text file
* [[Core Function FileAppendBinary|FileAppendBinary( <file>, <binary-array> )]] -- Append the data from a binary variable to the end of a previously opened file
* [[Core Function FileSeek|FileSeek( <file>, <offset>, <flag> )]] -- 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 FileReadBinary|FileReadBinary( <file>, <expression> )]] -- Read a number of bytes from a previously opened 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 (Or specify a name of a file)
* [[Core Function FileReadLines|FileReadLines( <file> )]] -- Read all lines of text from a previously opened text file (Or specify a name of a file)
* [[Core Function FileSave|FileSave( <file>, <expression> )]] -- Save all text to a file
* [[Core Function FileLoad|FileLoad( <file> )]] -- Load all text from a file

===== Misc =====
* [[Core Function FileCopy|FileCopy( <file1>, <file2>, <flag> )]] -- Copy a file
* [[Core Function FileDelete|FileDelete( <file> )]] -- Delete a file
* [[Core Function FileExists|FileExists( <file> )]] -- Check if a given file exists
* [[Core Function FileCreationTime|FileCreationTime( <file>, <flag> )]] -- Get the creation time of a file
* [[Core Function FileWriteTime|FileWriteTime( <file>, <flag> )]] -- Get the last write time of a file
* [[Core Function FileAccessTime|FileAccessTime( <file>, <flag> )]] -- Get the last access time of a file
* [[Core Function FileEncrypt|FileEncrypt( <file> )]] -- Encrypt a file so only the windows account used to encrypt it can decrypt it
* [[Core Function FileDecrypt|FileDecrypt( <file> )]] -- Decrypt a file previously encrypted by this windows user account
* [[Core Function FileMD5|FileMD5( <file> )]] -- Calculate the MD5 checksum of a file
* [[Core Function FileSHA1|FileSHA1( <file> )]] -- Calculate the SHA1 checksum of a file

===== Dialogs =====
* [[Core Function FileSaveDialog|FileSaveDialog ( <title>, <dir>, <filter>, <options>, <default name> )]] -- Initiates a Save File Dialog
* [[Core Function FileOpenDialog|FileOpenDialog ( <title>, <dir>, <filter>, <options>, <default name> )]] -- Initiates a Load File Dialog

==== Directory Functions ====
* [[Core Function GetFiles|GetFiles ( <path>, <pattern> )]] -- Get an array of all files in a directory
* [[Core Function GetFolders|GetFolders ( <path>, <pattern> )]] -- Get an array of all folders in a directory
* [[Core Function MKDir|MKDir ( <path> )]] -- Creates all directories and subdirectories as specified by path
* [[Core Function RMDir|RMDir ( <path>, <flag> )]] -- Deletes the specified directory and, if indicated, any subdirectories in the directory
* [[Core Function DirExists|DirExists ( <path> )]] -- Determines whether the given path refers to an existing directory on disk
* [[Core Function DirCopy|DirCopy ( <sourcepath>, <destpath> )]] -- Copies a directory and all sub-directories and files (Similar to xcopy)

===== Dialogs =====
* [[Core Function FolderSelectDialog|FolderSelectDialog ( <text>, <dir>, <flag>, <init dir> )]] -- Initiates a Browse For Folder Dialog

==== Path Functions ====
* [[Core Function HasExtension|HasExtension ( <path> )]] -- Determines whether a path includes a file name extension
* [[Core Function GetFullPath|GetFullPath ( <path> )]] -- Returns the absolute path for the specified path string
* [[Core Function GetDirectoryName|GetDirectoryName ( <path> )]] -- Returns the directory information for the specified path string
* [[Core Function GetExtension|GetExtension ( <path> )]] -- Returns the extension of the specified path string
* [[Core Function GetFileName|GetFileName ( <path> )]] -- Returns the file name and extension of the specified path string
* [[Core Function GetFileNameWithoutExtension|GetFileNameWithoutExtension ( <path> )]] -- Returns the file name of the specified path string without the extension
* [[Core Function GetPathRoot|GetPathRoot ( <path> )]] -- Gets the root directory information of the specified path
* [[Core Function IsPathRooted|IsPathRooted ( <path> )]] -- Gets a value indicating whether the specified path string contains absolute or relative path information

==== Network Functions ====

===== HTTP Functions =====
* [[Core Function HTTPFileExists|HTTPFileExists( <not available> )]] -- Check if a file exists at a given URL
* [[Core Function HTTPGetString|HTTPGetString( <not available> )]] -- Copy all text from a URL and return it as a string

===== MySQL Functions =====
* [[Core Function MySQLConnect|MySQLConnect( <ip/ip:port>, <login>, <password> )]] -- Connect to a MySQL database
* [[Core Function MySQLSelectDB|MySQLSelectDB( <mysql>, <db name> )]] -- Select a database
* [[Core Function MySQLQuery|MySQLQuery( <mysql>, <query> )]] -- Execute a query
* [[Core Function MySQLFill|MySQLFill( <mysql>, <query> )]] -- Grab a table or parts of it from the Database
* [[Core Function MySQLFetch|MySQLFetch( <mysql data> )]] -- Fetch the next row from a table
* [[Core Function MySQLFetchReset|MySQLFetchReset( <mysql data> )]] -- Reset the current position in the table rows to 0
* [[Core Function MySQLFields|MySQLFields( <mysql data> )]] -- Return how many Fields are in the table
* [[Core Function MySQLRows|MySQLRows( <mysql data> )]] -- Return how many Rows are in the table
* [[Core Function MySQLClose|MySQLClose( <mysql> )]] -- Close a MySQL connection

===== Sputnik Client/Server Functions (This is just for connecting Sputnik Clients to Sputnik Servers nothing else) =====
* [[Core Function SSListen|SSListen( <port>, <max connections>, <name> )]] -- Create a server and begin listening for clients to connect
* [[Core Function SSConnect|SSConnect( <ip>, <port>, <connection string>, <name> )]] -- Connect to a server
* [[Core Function SSApprove|SSApprove( <server>, <client socket> )]] -- Approve a client to connect to the server
* [[Core Function SSDisapprove|SSDisapprove( <server>, <client socket> )]] -- Disapprove a client to connect to the server
* [[Core Function SSClientStatus|SSClientStatus( /* depends... /* )]] -- Get the status of a client or of our client
* [[Core Function SSClientIP|SSClientIP( <server>, <client socket> )]] -- Get the IP of a client socket
* [[Core Function SSRecv|SSRecv( <server/client> )]] -- Check for a message recieved from client/server
* [[Core Function SSRead|SSRead( <message buffer>, <data type> )]] -- Read data from a message
* [[Core Function SSDrop|SSDrop( <server>, <client socket> )]] -- Kick a client off the server
* [[Core Function SSSendBufferCreate|SSSendBufferCreate( <server/client> )]] -- Create a new buffer to store data to send to the client/server
* [[Core Function SSSendBufferAppend|SSSendBufferAppend( <message buffer>, <type>, <data> )]] -- Add data to the buffer to send such as Strings etc
* [[Core Function SSSend|SSSend( /* depends... /* )]] -- Send data to client or server

===== Misc Network Functions =====
* [[Core Function HostResolve|HostResolve( <host name> )]] -- Resolves a host name such as google.com into an IP address
* [[Core Function Ping|Ping( <ip address/host name> )]] -- Pings a host and returns the roundtrip-time

==== Memory Functions ====
* [[Core Function WriteMem|WriteMem( < Caption / PID >, <Class>, <Address>, <value> )]] -- Write a value to an address in an application's memory (Supports multiple values and even binary variables for writing multiple bytes)
* [[Core Function ReadMem|ReadMem( < Caption / PID >, <Class>, <Address>, <defs>, <size> )]] -- Read bytes from an application's memory at an address and create variables using same defs and return values as Unpack()
* [[Core Function Alloc|Alloc( <size>, <flag> )]] -- Allocate memory and return the pointer to it
* [[Core Function Free|Free( <ptr> )]] -- Deallocate memory from a pointer
* [[Core Function StringToPTR|StringToPTR( <type>, <string> )]] -- Allocates memory for the string and writes the string to that memory and returns the pointer for that memory
* [[Core Function PTRToString|PTRToString( <type>, <ptr> )]] -- Reads a string from a memory pointer
* [[Core Function PTRRead|PTRRead( <ptr>, <type>, <offset> )]] -- Read data from a memory pointer optionally starting from a given index
* [[Core Function PTRWrite|PTRWrite( <ptr>, <type>, <offset>, <value> )]] -- Write data to a memory pointer optionally starting from a given index

==== GUI Functions ====

===== Dialog Creation Functions =====
* [[Core Function GUICreate|GUICreate( <Title>, <Width>, <Height>, <Left>, <Top> )]] -- Create new GUI window
* [[Core Function DoEvents|DoEvents( )]] -- Keep GUI window active by dispatching all messages in the queue

===== Dialog Properties Get/Set Functions =====
* [[Core Function GUIState|GUIState( <expression> )]] -- Gets current GUI state
* [[Core Function GUISetState|GUISetState( <expression> )]] -- Sets GUI state

===== Control Creation Functions =====
* [[Core Function GUICreateButton|GUICreateButton( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a button
* [[Core Function GUICreateTextBox|GUICreateTextBox( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a Textbox
* [[Core Function GUICreateTextBoxEx|GUICreateTextBoxEx( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a multiline Textbox
* [[Core Function GUICreatePassword|GUICreatePassword( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a Passweord Box
* [[Core Function GUICreateLabel|GUICreateLabel( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a Label
* [[Core Function GUICreateCheckBox|GUICreateCheckBox( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a CheckBox
* [[Core Function GUICreateTimer|GUICreateTimer( <gui/container>, <name>, <interval> )]] -- Create a timer
* [[Core Function GUICreateDataGrid|GUICreateDataGrid( <gui/container>, <name>, <left>, <top>, <width>, <height> )]] -- Create a Data Grid
* [[Core Function GUICreateGroupBox|GUICreateGroupBox( <gui/container>, <name>, <text>, <left>, <top>, <width>, <height> )]] -- Create a GroupBox
* [[Core Function GUICreateTabSheet|GUICreateTabSheet( <gui/container>, <name>, <left>, <top>, <width>, <height> )]] -- Create a TabSheet

===== Event Linking Functions =====
* [[Core Function GUILink|GUILink( <gui/guiobject>, <linktype> )]] -- Links an event to a GUI or GUI Object

===== Common Dialog/Control Properties Get/Set Functions =====
* [[Core Function GUIGetProp|GUIGetProp( <gui object>, <prop> )]] -- Get the value of a GUI objects property
* [[Core Function GUISetProp|GUISetProp( <gui object>, <prop>, <value> )]] -- Set the value of a GUI objects property
===== Common Dialog/Control Method Functions =====
* [[Core Function GUIPropInvoke|GUIPropInvoke( <gui/gui object>, <method> )]] -- Invoke a method of the GUI/GUIObject such as Focus()

===== GUIGetProp & GUISetProp Examples =====
Here are some GUIGetProp & GUISetProp Examples that you might not figure out by yourself.
* [[GUI GetSet Prop Example Colour|Change colour of controls]] -- Shows how to change the background and foreground colour on Buttons, Windows etc.

===== Control Properties Get/Set Functions =====
* [[Core Function GUITimerStart|GUITimerStart( <timer> )]] -- Starts specified timer
* [[Core Function GUITimerStop|GUITimerStop( <timer> )]] -- Stops specified timer
* [[Core Function GUIDataGrid|GUIDataGrid( <datagrid> )]] -- Properties & Functions specifically for Data Grid
* [[Core Function GUITabSheet|GUITabSheet( <tabsheet> )]] -- Properties & Functions specifically for Tab Sheet

===== Other GUI Functions =====
* [[Core Function GUIMsgFilter|GUIMsgFilter( <gui>, <command> )]] -- Use a function to recieve all messages windows sends to the GUI window (HWND, MSG, WPARAM, LPARAM)
* [[Core Function GUICreateFont|GUICreateFont( <name>, <size>, <style> )]] -- Create a new font for use on buttons etc
* [[Core Function GUIFont|GUIFont( < font >, <setting>, <value> )]] -- Change the style, size etc on a font object
* [[Core Function MsgBox|MsgBox( <message>, <title>, <flag>, <timeout> )]] -- Show a message dialog
* [[Core Function InputBox|InputBox( <title>, <message>, <default text> )]] -- Shows a box to input text.
* [[Core Function ToolTip|ToolTip( <text>, <x>, <y> )]] -- Creates a tooltip anywhere on the screen.
* [[Core Function ToolTipKill|ToolTipKill( <ToolTip> )]] -- Delete a tooltip that was made using ToolTip().

==== Keyboard Control Functions ====
* [[Core Function HotKeySet|HotKeySet( <keydef>, <expression> )]] -- Create a custom hotkey to run custom code or execute a function.
* [[Core Function SendKeys|SendKeys( <keydef>, <flag> )]] -- Sends simulated keystrokes to the active window

==== Mouse Control Functions ====
* [[Core Function MouseClick|MouseClick ( <button>, <x>, <y>, <clicks>, <speed> )]] -- Perform a mouse click operation
* [[Core Function MouseClickDrag|MouseClickDrag ( <button>, <x1>, <y1>, <x2>, <y2>, <speed> )]] -- Perform a mouse click and drag operation
* [[Core Function MouseDown|MouseDown ( <button> )]] -- Perform a mouse down event at the current mouse position
* [[Core Function MouseUp|MouseUp ( <button> )]] -- Perform a mouse up event at the current mouse position
* [[Core Function MouseMove|MouseMove ( <x>, <y>, <speed> )]] -- Moves the mouse pointer
* [[Core Function MouseGetPos|MouseGetPos ( )]] -- Retrieves the current position of the mouse cursor
* [[Core Function MouseWheel|MouseWheel ( <direction>, <clicks> )]] -- Moves the mouse wheel up or down

==== Window Management Functions ====
(For info on using <title>, <text> See [[Window Titles and Text Advanced|Window Titles and Text (Advanced)]] )

* [[Core Function WinActivate|WinActivate ( <title>, <text> )]] -- Activates (gives focus to) a window
* [[Core Function WinActive|WinActive ( <title>, <text> )]] -- Checks to see if a specified window exists and is currently active
* [[Core Function WinExists|WinExists ( <title>, <text> )]] -- Checks to see if a specified window exists
* [[Core Function WinGetClassList|WinGetClassList ( <title>, <text> )]] -- Retrieves the classes from a window
* [[Core Function WinGetHandle|WinGetHandle ( <title>, <text> )]] -- Retrieves the internal handle of a window
* [[Core Function WinGetPos|WinGetPos ( <title>, <text> )]] -- Retrieves the position and size of a given window
* [[Core Function WinGetCaretPos|WinGetCaretPos ( )]] -- Returns the coordinates of the caret in the foreground window
* [[Core Function WinGetTitle|WinGetTitle ( <title>, <text> )]] -- Retrieves the full title from a window
* [[Core Function WinGetText|WinGetText ( <title>, <text> )]] -- Retrieves the text from a window
* [[Core Function WinGetState|WinGetState ( <title>, <text> )]] -- Retrieves the state of a given window
* [[Core Function WinGetProcess|WinGetProcess ( <title>, <text> )]] -- Retrieves the Process ID (PID) associated with a window
* [[Core Function WinGetClientSize|WinGetClientSize ( <title>, <text> )]] -- Retrieves the size of a given window's client area
* [[Core Function WinClose|WinClose ( <title>, <text> )]] -- Closes a window
* [[Core Function WinKill|WinKill ( <title>, <text> )]] -- Forces a window to close
* [[Core Function WinMove|WinMove ( <title>, <text>, <x>, <y>, <width>, <height> )]] -- Moves and/or resizes a window
* [[Core Function WinWait|WinWait ( <title>, <text>, <timeout> )]] -- Waits until the requested window exists
* [[Core Function WinWaitActive|WinWaitActive ( <title>, <text>, <timeout> )]] -- Waits until the requested window is active
* [[Core Function WinWaitNotActive|WinWaitNotActive ( <title>, <text>, <timeout> )]] -- Waits until the requested window is not active
* [[Core Function WinWaitClose|WinWaitClose ( <title>, <text>, <timeout> )]] -- Waits until the requested window does not exist
* [[Core Function WinSetTitle|WinSetTitle ( <title>, <text>, <newtitle> )]] -- Changes the title of a window
* [[Core Function WinSetState|WinSetState ( <title>, <text>, <flag> )]] -- Shows, hides, minimizes, maximizes, or restores a window
* [[Core Function WinSetTrans|WinSetTrans ( <title>, <text>, <transparency> )]] -- Sets the transparency of a window
* [[Core Function WinMinimizeAll|WinMinimizeAll ( )]] -- Minimizes all windows
* [[Core Function WinMinimizeAllUndo|WinMinimizeAllUndo ( )]] -- Undoes a previous WinMinimizeAll function
* [[Core Function WinFlash|WinFlash ( <title>, <text>, <flashes>, <delay> )]] -- Flashes a window in the taskbar
* [[Core Function WinList|WinList ( <title>, <text> )]] -- Retrieves a list of windows

===== Controls =====
(For info on using <title>, <text> See [[Window Titles and Text Advanced|Window Titles and Text (Advanced)]] )

* [[Core Function ControlClick|ControlClick ( <title>, <text>, <controlID> )]] -- Sends a mouse click command to a given control
* [[Core Function ControlSend|ControlSend ( <title>, <text>, <controlID>, <string> <flag> )]] -- Sends a string of characters to a control
* [[Core Function ControlGetFocus|ControlGetFocus ( <title>, <text> )]] -- Returns the ControlRef# of the control that has keyboard focus within a specified window
* [[Core Function ControlGetPos|ControlGetPos ( <title>, <text>, <controlID> )]] -- Retrieves the position and size of a control relative to it's window
* [[Core Function ControlDisable|ControlDisable ( <title>, <text>, <controlID> )]] -- Disables a control
* [[Core Function ControlEnable|ControlEnable ( <title>, <text>, <controlID> )]] -- Enables a control
* [[Core Function ControlShow|ControlShow ( <title>, <text>, <controlID> )]] -- Shows a control that was hidden
* [[Core Function ControlHide|ControlHide ( <title>, <text>, <controlID> )]] -- Hides a control

==== Graphics/Pixel Functions ====
* [[Core Function PixelGetColour|PixelGetColour ( <x>, <y> )]] -- Returns a pixel colour according to x, y pixel coordinates
* [[Core Function PixelGetMouse|PixelGetMouse ( )]] -- Returns a pixel colour according to x, y position of the mouse pointer
* [[Core Function PixelSearch|PixelSearch ( <left>, <top>, <right>, <bottom>, <colour>, <shade>, <step> )]] -- Searches a rectangle of pixels for the pixel colour provided
* [[Core Function PixelChecksum|PixelChecksum ( <left>, <top>, <right>, <bottom>, <step> )]] -- Generates a checksum for a region of pixels
* [[Core Function Colour|Colour( <name> )]] -- Get the colour INT value of a given colours name
* [[Core Function RGB|RGB( <red>, <green>, <blue> )]] -- Get the colour INT value of given red, green and blue bytes
* [[Core Function GetRValue|GetRValue( <colour> )]] -- Get the red byte from a colour INT value
* [[Core Function GetGValue|GetGValue( <colour> )]] -- Get the green byte from a colour INT value
* [[Core Function GetBValue|GetBValue( <colour> )]] -- Get the blue byte from a colour INT value

==== Misc Functions ====
* [[Core Function Call|Call <function>, <expressions>]] -- Calls a function contained in a string parameter
* [[Core Function Return|Return <expressions>]] -- Returns a result from a Function
* [[Core Function Throw|Throw( <expression> )]] -- Throw an exception
* [[Core Function Die|Die( <expression> )]] -- Gives an error and terminates the program
* [[Core Function Eval|Eval( <expression>, <flag> )]] -- Evaluate a string as Sputnik code
* [[Core Function GC|GC( <flag> )]] -- Use the garbage collector
* [[Core Function Require|Require( <file>, <flag> )]] -- Add all functions etc from a file for use
* [[Core Function Include|Include( <file>, <flag> )]] -- Add all functions etc from a file for use and execute all expressions
* [[Core Function Opt|Opt( <option>, <value> )]] -- Changes the operation of various Sputnik functions/parameters

=== User Defined Functions ===

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

[[Category:Language Reference]]

Core Function BinarySave

2011-12-04T20:48:09Z

Alexpja:

<pre>
BinarySave( <binary-array>, <file>, <flag> )
</pre>

=== Description ===

Save a binary variable data to file.

=== Parameters ===

==== <binary-array> ====

The binary variable you want saving to file.

==== file ====

Name of file to save (Will create if it doesn't exist).

==== flag ====

Optional; Compression flag.

0 = Do not compress the file

1 = Compress the file (This will create a gzip stream then use the first 4 bytes to write the size of the binary variable array then it will write all the bytes of the array; You can load the file back into a binary variable by using BinaryLoad command with compression switch on)

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

This will even accurately save exe files without damage so they can run.

Warning - If you use compression on a loaded exe file the newly made exe will not run.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = BinaryLoad("Sputnik.exe");
println("Size is : " . BinaryLen($binary) );
BinarySave($binary, "SputnikTest.exe");
</syntaxhighlight>

; Example with compression
<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!\n" x 1_000);
BinarySave($binary, "test.txt", 1);
$binaryLoaded = BinaryLoad("test.txt", 1);
println( Unpack("z0", $binaryLoaded) ); // Prints "Hello World!" 1000 times
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryResize

2011-12-04T20:46:55Z

Alexpja:

<pre>
BinaryResize( <binary-array>, <size>, <data> )
</pre>

=== Description ===

Resize a binary variables data array.

=== Parameters ===

==== binary-array ====

The binary variable to use.

==== size ====

The new size for the binary variables data array.

==== data ====

Optional; The byte to place into all new slots (Assuming the new array is larger than the old).

Default is 0

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

This modifies the original binary variable and does not return a copy.

=== Example ===

Resize a binary to contain just 1 word:

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!");
BinaryResize($binary, 5);
$k = 0;
Foreach ($binary as $i)
{
println( "($k) Byte: " . $i . " | Hex: " . Hex($i) . " | Char: " . Chr($i) );
$k++;
}
println( Unpack("z0", $binary) ); // Prints: Hello
</syntaxhighlight>

Resize a binary and fill in the gaps with ! symbols :

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!");
BinaryResize($binary, 20, Asc("!"));
$k = 0;
Foreach ($binary as $i)
{
println( "($k) Byte: " . $i . " | Hex: " . Hex($i) . " | Char: " . Chr($i) );
$k++;
}
println( Unpack("z0", $binary) ); // Prints: Hello World!!!!!!!!!
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryPop

2011-12-04T20:45:02Z

Alexpja:

<pre>
BinaryPop( <binary-array> )
</pre>

=== Description ===

Delete the last byte from a binary variable.

=== Parameters ===

==== binary-array ====

The binary variable to use.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

Binary data is not really meant to be resized like crazy, so if you have a LOT of data, it is best to avoid using this too often.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "1234");
println( "'" . Unpack("z0", $binary) . "'" ); // Prints: 1234
BinaryPop($binary);
println( "'" . Unpack("z0", $binary) . "'" ); // Prints: 123
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryShift

2011-12-04T20:44:27Z

Alexpja:

<pre>
BinaryShift( <binary-array> )
</pre>

=== Description ===

Delete the first byte from a binary variable.

=== Parameters ===

==== binary-array ====

The binary variable to use.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

Binary data is not really meant to be resized like crazy, so if you have a LOT of data, it is best to avoid using this too often.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "1234");
println( "'" . Unpack("z0", $binary) . "'" ); // Prints: 1234
BinaryShift($binary);
println( "'" . Unpack("z0", $binary) . "'" ); // Prints: 234
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryPush

2011-12-04T20:43:44Z

Alexpja:

<pre>
BinaryPush( <binary-array>, <byte> )
</pre>

=== Description ===

Add a byte to the end of a binary variable.

=== Parameters ===

==== binary-array ====

The binary variable to use.

==== byte ====

The byte to add to the end of the binary data.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

Binary data is not really meant to be resized like crazy, so if you have a LOT of data, it is best to avoid using this too often.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "One");
BinaryPush($binary, Asc(" "));
BinaryPush($binary, Asc("T"));
BinaryPush($binary, Asc("w"));
BinaryPush($binary, Asc("o"));
println( "'" . Unpack("z0", $binary) . "'" ); // Prints: One Two
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryUnshift

2011-12-04T20:42:50Z

Alexpja:

<pre>
BinaryUnshift( <binary-array>, <byte> )
</pre>

=== Description ===

Add a byte to the beginning of a binary variable.

=== Parameters ===

==== binary-array ====

The binary variable to use.

==== byte ====

The byte to add to the beginning of the binary data.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

Binary data is not really meant to be resized like crazy, so if you have a LOT of data, it is best to avoid using this too often.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "One");
BinaryUnshift($binary, Asc(" "));
BinaryUnshift($binary, Asc("o"));
BinaryUnshift($binary, Asc("w"));
BinaryUnshift($binary, Asc("T"));
println( "'" . Unpack("z0", $binary) . "'" ); // Prints: Two One
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryAppend

2011-12-04T20:41:55Z

Alexpja:

<pre>
BinaryAppend( <binary-array>, <binary-array2>, <flag> )
</pre>

=== Description ===

Append a binary variables data onto the end or beginning of another binary variables data.

=== Parameters ===

==== binary-array ====

The binary variable to append to.

==== binary-array2 ====

The binary variable to be appended.

==== flag ====

Optional; Flag to choose where to append to:

0 = Append to end

1 = Append to beginning

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

This modifies the original variable and does not return a copy of it.

=== Example ===

Append data to end:

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "The quick brown FoX");
$binary2 = Pack("z0", " jumps over the lazy dog");
BinaryAppend($binary, $binary2);
println( Unpack("z0", $binary) ); // Prints: The quick brown FoX jumps over the lazy dog
</syntaxhighlight>

Append data to beginning:

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "The quick brown FoX");
$binary2 = Pack("z0", " jumps over the lazy dog");
BinaryAppend($binary, $binary2, 1);
println( Unpack("z0", $binary) ); // Prints: jumps over the lazy do gThe quick brown FoX
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryAppend

2011-12-04T20:41:47Z

Alexpja:

<pre>
BinaryAppend( <binary-array>, <binary-array2>, <flag> )
</pre>

=== Description ===

Append a binary variables data onto the end or beginning of another binary variables data.

=== Parameters ===

==== binary-array ====

The binary variable to append to.

==== binary-array2 ====

The binary variable to be appended.

==== flag ====

Optional; Flag to choose where to append to:

0 = Append to end

1 = Append to beginning

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

This modifies the original variable and does not return a copy of it.

=== Example ===

Append data to end:

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "The quick brown FoX");
$binary2 = Pack("z0", " jumps over the lazy dog");
BinaryAppend($binary, $binary2);
println( Unpack("z0", $binary) ); // Prints: The quick brown FoX jumps over the lazy dog
</syntaxhighlight>

Append data to beginning:

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "The quick brown FoX");
$binary2 = Pack("z0", " jumps over the lazy dog");
BinaryAppend($binary, $binary2, 1);
println( Unpack("z0", $binary) ); // Prints: jumps over the lazy dogThe quick brown FoX
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryGet

2011-12-04T20:37:24Z

Alexpja:

<pre>
BinaryGet( <binary-array>, <index> )
</pre>

=== Description ===

Get the byte at an index of a binary variable.

=== Parameters ===

==== binary-array ====

The binary variable to use.

==== index ====

Any valid numeric expression.

=== Return Value ===

Success: Returns the byte at the given location.

Failure: Returns 0.

=== Remarks ===

None.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = BinaryHex("48656c");
println( "Binary 0: '" . BinaryGet($binary, 0) );
println( "Binary 1: '" . BinaryGet($binary, 1) );
println( "Binary 2: '" . BinaryGet($binary, 2) );
// Now show all
println( "All:" );
for( $i = 0; $i < BinaryLen($binary); $i++)
{
println( "Binary $i: '" . BinaryGet($binary, $i) );
}
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryWipe

2011-12-04T20:32:41Z

Alexpja:

<pre>
BinaryWipe( <binary-array> )
</pre>

=== Description ===

Wipes a binary variables data 100% and sets the variable to a blank int containing just 0.

=== Parameters ===

==== binary-array ====

The binary variable to wipe.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

This will only wipe this individual variable it will not wipe every variable containing a reference to this binary data.

What this means is its quite possible you will free no memory from using this unless you also wipe all other binary variables using this data.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!\n" x 1000);
println( "Before Wipe: " . Unpack("z0", $binary) );
BinaryWipe($binary);
println( "After Wipe: " . $binary );
</syntaxhighlight>

This is just as effective.

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!\n" x 1000);
println( "Before Wipe: " . Unpack("z0", $binary) );
$binary = 0;
println( "After Wipe: " . $binary );
</syntaxhighlight>

Also, this is just as effective.

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!\n" x 1000);
println( "Before Wipe: " . Unpack("z0", $binary) );
unset($binary);
println( "After Wipe: " . $binary );
</syntaxhighlight>

[[Category:Core Function]]

Core Function BinaryClone

2011-12-04T20:31:41Z

Alexpja:

<pre>
BinaryClone( <binary-array> )
</pre>

=== Description ===

Clone a binary variable 100% and return a new binary variable with exactly same data as the old one.

=== Parameters ===

==== binary-array ====

The binary variable to use.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

Contrary to what you might think simply doing
<syntaxhighlight lang="sputnik">
$binary2 = $binary1
</syntaxhighlight>

That does not *copy* the data it will simply creates a reference to it making a change at either variable will change both so if you wish to actually copy a binary variables data you will need to use BinaryClone or BinaryMid etc.

=== Example ===

<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!");
$binary2 = BinaryClone($binary);
BinaryReverse($binary);
println("b1: " . Unpack("z0", $binary));
println("b2: " . Unpack("z0", $binary2));
</syntaxhighlight>

[[Category:Core Function]]

Core Function Pack

2011-12-04T20:30:02Z

Alexpja:

<pre>
Pack( <expression>, <expressions> )
</pre>

=== Description ===

Pack data into a binary array

==== expression ====

The format string to use.

==== expressions ====

One or more expressions to convert.

=== Return Value ===

Success: Returns a binary variable which contains the array of bytes.

Failure: Returns empty array.

=== Remarks ===

To access the binary data in the variable you will need to either request elements from index id, cycle through all elements in a loop or use the Unpack function to convert the binary array into something useful.

Its worth noting you can cycle through a Binary variable like this :
<syntaxhighlight lang="sputnik">
$binary = Pack("z0", "Hello World!");
Foreach ($binary as $i)
{
println( "Byte: " . $i . " | Hex: " . Hex($i) . " | Char: " . Chr($i) );
}
</syntaxhighlight>

==== Control Specifiers ====

{| border="1" align="left" style="text-align:center;"
|Character
|Description
|-
|^
|Switch to big endian encoding
|-
|_
|Switch to little endian encoding
|-
|%
|Switch to host (native) encoding
|-
|!
|Aligns the next data type to its natural boundary, for example for a double that would be 8 bytes, for a 32-bit int, that would be 4 bytes. For strings this is set to 4.
|-
|N
|A number between 1 and 9, indicates a repeat count (process N items with the following datatype
|-
|[N]
|For numbers larger than 9, use brackets, for example [20]
|-
|*
|Repeat the next data type until the arguments are exhausted
|}

==== Data Encoding ====

Warning - The pack for $variables is designed to create the bytes of the arrays elements such as array of ints however it does not unpack to a $variable instead you must unpack it as the base type you packed it to such as Int32.

{| border="1" align="left" style="text-align:center;"
|Character
|Description
|-
|s
|Int16
|-
|S
|UInt16
|-
|i
|Int32
|-
|I
|UInt32
|-
|l
|Int64
|-
|L
|UInt64
|-
|f
|float
|-
|d
|double
|-
|b
||byte
|-
|c
|1-byte signed character
|-
|C
|1-byte unsigned character
|-
|h
|Hex string to convert to bytes (For Pack)
|-
|h
|2 Char Lowercase Hexstring of a byte (For Unpack)
|-
|H
|2 Char Uppercase Hexstring of a byte (For Unpack)
|-
|z8
|string encoded as UTF8 with 1-byte null terminator
|-
|z6
|string encoded as UTF16 with 2-byte null terminator
|-
|z7
|string encoded as UTF7 with 1-byte null terminator
|-
|zb
|string encoded as BigEndianUnicode with 2-byte null terminator
|-
|z3
|string encoded as UTF32 with 4-byte null terminator
|-
|z4
|string encoded as UTF32 big endian with 4-byte null terminator
|-
|z0
|ASCII string without a null terminator
|-
|z1
|ASCII string with 1-byte terminator
|-
|$ab
|A $variable containing an array of Byte values
|-
|$as
|A $variable containing an array of Int16 values
|-
|$aS
|A $variable containing an array of UInt16 values
|-
|$ai
|A $variable containing an array of Int32 values
|-
|$aI
|A $variable containing an array of UInt32 values
|-
|$al
|A $variable containing an array of Int64 values
|-
|$aL
|A $variable containing an array of UInt64 values
|-
|$af
|A $variable containing an array of Float values
|-
|$ad
|A $variable containing an array of Double values
|-
|x
|null byte
|}

=== Example ===

Converting an array of Ints into bytes then back into an array of ints again:

<syntaxhighlight lang="sputnik">
$oldArray = array(100, 200, 300, 400); // Create an array
// Pack the array into bytes with each element converted to Int32
$binary = Pack('$ai', $oldArray); // NOTICE '' was used instead of ""? This is vital when packing variables or else it will fail
Foreach ($binary as $i)
{
println( "Byte: " . $i ); // Prints the bytes just for looksee
}
$newArray = Unpack('*i', $binary); // Unpack All the Int32s into an array
println("Old Array : " . $oldArray);
println("New Array : " . $newArray);
</syntaxhighlight>

Same as above but this time packing a float and a double as well :

<syntaxhighlight lang="sputnik">
$oldArray = array(100, 200, 300, 400); // Create an array
// Pack the array into bytes with each element converted to Int32
$binary = Pack('$aifd', $oldArray, (float)777, (double)1337.42); // NOTICE '' was used instead of ""? This is vital when packing variables or else it will fail
Foreach ($binary as $i)
{
println( "Byte: " . $i ); // Prints the bytes just for looksee
}
$newArray = Unpack('4ifd', $binary); // Unpack 4 Int32s, 1 float and 1 double into an array
println("Old Array : " . $oldArray);
println("New Array : " . $newArray);
foreach ($newArray as $i)
{
println("Value: " . $i );
}
</syntaxhighlight>

Of course we could set how many Ints to decode dynamically example:

<syntaxhighlight lang="sputnik">
$oldArray = array(100, 200, 300, 400); // Create an array
// Pack the array into bytes with each element converted to Int32
$binary = Pack('$aifd', $oldArray, (float)777, (double)1337.42); // NOTICE '' was used instead of ""? This is vital when packing variables or else it will fail
Foreach ($binary as $i)
{
println( "Byte: " . $i ); // Prints the bytes just for looksee
}
$newArray = Unpack(UBound($oldArray) . 'ifd', $binary); // Unpack 4 Int32s, 1 float and 1 double into an array
println("Old Array : " . $oldArray);
println("New Array : " . $newArray);
foreach ($newArray as $i)
{
println("Value: " . $i );
}
</syntaxhighlight>

Convert a string into a binary array and back again:

<syntaxhighlight lang="sputnik">
$arr = Pack("z0", "Hello World!");
foreach ($arr as $i)
{
println($i);
}
$str = Unpack("z0", $arr);
println($str);
</syntaxhighlight>

Convert a dobule into a binary array and back again:
<syntaxhighlight lang="sputnik">
$arr = Pack("d", 777.42);
foreach ($arr as $i)
{
println($i);
}
$str = Unpack("d", $arr);
println($str);
</syntaxhighlight>

Convert a int into a binary array and back again:
<syntaxhighlight lang="sputnik">
$arr = Pack("d", (int)777);
foreach ($arr as $i)
{
println($i);
}
$str = Unpack("d", $arr);
println($str);
</syntaxhighlight>

Convert a string into a hex and back again:
<syntaxhighlight lang="sputnik">
$hex = Join(Unpack("*H", Pack("z0", "Hello World!")), '');
println("Hex String: " . $hex);
$str = Unpack("z0", Pack("h", $hex));
println("Normal String: " . $str);
</syntaxhighlight>

Convert a string into a hex and back again (alternative 1):
<syntaxhighlight lang="sputnik">
$hex = Unpack("*H", "Hello World!", 1);
println("Hex String: " . $hex);
$str = Unpack("z0", Pack("h", $hex));
println("Normal String: " . $str);
</syntaxhighlight>

Convert a string into a hex and back again (alternative 2):
<syntaxhighlight lang="sputnik">
$hex = Unpack("*H", "Hello World!", 1);
println("Hex String: " . $hex);
$hex =~ s/([\dA-Fa-f][\dA-Fa-f])/Chr(Dec($1))/ego;
println("Normal String: " . $hex);
</syntaxhighlight>

To pack two integers in big endian format, you would use this:
<syntaxhighlight lang="sputnik">
$bytes = Pack ("^ii", 1234, 4542);
</syntaxhighlight>

More Examples:
<syntaxhighlight lang="sputnik">
; The following means:
; Little endian encoding of a Int16, followed by an aligned
; int32 value.
$r = Pack("_s!i", 0x7b, 0x12345678);
foreach ($r as $i)
{
print(Hex($i) . " ");
}
// Prints 7B 0 0 0 80 56 34 12

$bytes = Pack("CCCC", 65, 66, 67, 68);
foreach ($bytes as $i)
{
print(Chr($i) . " ");
} // Prints 4-byte sequence for "ABCD"

$bytes = Pack("4C", 65, 66, 67, 68);
foreach ($bytes as $i)
{
print(Chr($i) . " ");
} // Prints 4-byte sequence for "ABCD"

$bytes = Pack("*C", 65, 66, 67, 68);
foreach ($bytes as $i)
{
print(Chr($i) . " ");
} // Prints 4-byte sequence for "ABCD"

$bytes = Pack("^ii", 0x1234abcd, 0x7fadb007);
foreach ($bytes as $i)
{
print(Hex($i) . " ");
}
println(""); // Result: 12 34 ab cd 7f ad b0 07

// Encode 3 integers as big-endian, but only provides two as arguments,
// this defaults to zero for the last value.
$bytes = Pack("^iii", 0x1234abcd, 0x7fadb007);
foreach ($bytes as $i)
{
print(Hex($i) . " ");
}
println(""); // Result: 12 34 ab cd 7f ad b0 07 00 00 00 00

// Encode as little endian, pack 1 short, align, 1 int
$bytes = Pack("_s!i", 0x7b, 0x12345678);
foreach ($bytes as $i)
{
print(Hex($i) . " ");
}
println(""); // Result: 7b 00 00 00 78 56 34 12

// Encode a string in utf-8 with a null terminator
$bytes = Pack("z8", "hello");
foreach ($bytes as $i)
{
print(Hex($i) . " ");
}
println(""); // Result: 68 65 6c 6c 6f 00 00 00 00

// Little endian encoding, for Int16, followed by an aligned
// Int32
$bytes = Pack("_s!i", 0x7b, 0x12345678);
foreach ($bytes as $i)
{
print(Hex($i) . " ");
}
println(""); // Result: 7b 00 00 00 78 56 34 12
</syntaxhighlight>

[[Category:Core Function]]

Core Function GetVarObjType

2011-12-04T20:27:59Z

Alexpja:

<pre>
GetVarObjType( $variable )
</pre>

=== Description ===

Get the common object type of a variable (If it is an object)

=== Parameters ===

==== variable ====

The variable to check.

=== Return Value ===

Returns the common object type a variable as a numeric value types are:
<pre>
[CODE] [TYPE] [@MACRO]
0 CLASS @typeCLASS
1 FILE @typeFILE
2 BINARY @typeBINARY
3 GUI @typeGUI
4 GUIObject @typeGUIObject
5 ASSEMBLY @typeASSEMBLY
6 METHOD @typeMETHOD
7 MYSQL @typeMYSQL
8 MYSQLDATA @typeMYSQLDATA
9 DLLSTRUCT @typeDLLSTRUCT
10 OBJECT @typeOBJECT
11 SERVER @typeSERVER
12 CLIENT @typeCLIENT
</pre>

=== Remarks ===

None.

=== Example ===

Checking as numeric

<syntaxhighlight lang="sputnik">
$a = "My value";

if( GetVarObjType($a) == 11 ) // Server
{
}

switch( GetVarObjType($a) )
{
case 9: // DLLStruct
{
}
break;
case 10: // Object (Unknown object that doesn't have its own type in Sputnik yet most likely)
{
}
break;
}
</syntaxhighlight>

Checking using @ Macro of the numeric
<syntaxhighlight lang="sputnik">
$a = "My value";

if( GetVarObjType($a) == @typeCLIENT )
{
}

switch( GetVarObjType($a) )
{
case @typeCLASS:
{
}
break;
case @typeMYSQLDATA:
{
}
break;
}

</syntaxhighlight>

[[Category:Core Function]]

Core Function isVarClass

2011-12-04T20:23:20Z

Alexpja:

<pre>
isVarClass( $variable, <type> )
</pre>

=== Description ===

Check if a variable's object type is a class.

=== Parameters ===

==== variable ====

The variable to check.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0 if parameter is not an array variable.

=== Remarks ===

Can be useful to validate array/non-array parameters to user-defined functions.

=== Example ===

A simple example to see if a variable is a class variable :

<syntaxhighlight lang="sputnik">
Class Vec3
{
my $x = 0;
my $y = 0;
my $z = 0;
Function Vec3($x1 = 0, $y1 = 0, $z1 = 0)
{
$this->$x = (double)$x1;
$this->$y = (double)$y1;
$this->$z = (double)$z1;
}
};
$cat1 = new Vec3(10, 20, 30);
println( isVarClass($cat1) ? "TRUE" : "FALSE" );
println( isVarClass($moo) ? "TRUE" : "FALSE" );
</syntaxhighlight>

Same example but this time making sure the class is a vec3 and nothing else:

<syntaxhighlight lang="sputnik">
Class Vec3
{
my $x = 0;
my $y = 0;
my $z = 0;
Function Vec3($x1 = 0, $y1 = 0, $z1 = 0)
{
$this->$x = (double)$x1;
$this->$y = (double)$y1;
$this->$z = (double)$z1;
}
};
$cat1 = new Vec3(10, 20, 30);
println( isVarClass($cat1, "vec3") ? "TRUE" : "FALSE" );
println( isVarClass($moo, "vec3") ? "TRUE" : "FALSE" );
</syntaxhighlight>

[[Category:Core Function]]

Core Function isVarByte

2011-12-04T20:14:31Z

Alexpja:

<pre>
isVarByte( $variable )
</pre>

=== Description ===

Checks if a variable is a unsigned 8-bit integer type.

=== Parameters ===

==== variable ====

The variable to check.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

None.

=== Example ===

<syntaxhighlight lang="sputnik">
$var1 = "check me";
println( "Is it?: " . isVarByte($var1) );
</syntaxhighlight>

[[Category:Core Function]]

Core Function isVarSByte

2011-12-04T20:04:48Z

Alexpja:

<pre>
isVarSByte( $variable )
</pre>

=== Description ===

Checks if a variable is a signed 8-bit integer type.

=== Parameters ===

==== variable ====

The variable to check.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

None.

=== Example ===

<syntaxhighlight lang="sputnik">
$var1 = "check me";
println( "Is it?: " . sVarSByte($var1) );
</syntaxhighlight>

[[Category:Core Function]]

Core Function isVarByte

2011-12-04T20:04:28Z

Alexpja:

<pre>
isVarByte( $variable )
</pre>

=== Description ===

Checks if a variable is a unsigned 8-bit integer type.

=== Parameters ===

==== variable ====

The variable to check.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

None.

=== Example ===

<syntaxhighlight lang="sputnik">
$var1 = "check me";
println( "Is it?: " . sVarByte($var1) );
</syntaxhighlight>

[[Category:Core Function]]

Core Function IsDeclared

2011-12-04T20:00:42Z

Alexpja:

<pre>
IsDeclared( <variable name> )
</pre>

=== Description ===

Check if a variable has been declared

=== Parameters ===

==== Expression ====

String representing name of the variable to be checked.

=== Return Value ===

Success: Returns 1 if variable has been assigned.

Failure: Returns 0 if variable doesn't exist yet.

=== Remarks ===

=== Example ===

<syntaxhighlight lang="sputnik">
If (!IsDeclared("a"))
MsgBox('$a is NOT declared'); // $a has never been assigned

$a=1;

If (IsDeclared ("a"))
MsgBox('$a IS declared'); //due to previous $a=1 assignment
</syntaxhighlight>

[[Category:Core Function]]

Window Titles and Text Advanced

2011-12-04T19:57:12Z

Alexpja:

=== Description ===

Sputnik operates in one of five "Window matching" modes.

The modes are set with the Opt() function using the WinTitleMatchMode and WinTextMatchMode option.

=== Remarks ===

'''Mode 1 (default)'''

Matches partial titles from the start.

In this mode the a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Untitled", "Un", etc.

e.g.

<syntaxhighlight lang="sputnik">
WinWait("Untitled");
</syntaxhighlight>

'''Mode 2'''

Matches partial titles from the end.

In this mode the a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Notepad", "pad", etc.

e.g.

<syntaxhighlight lang="sputnik">
WinWait("pad");
</syntaxhighlight>

'''Mode 3'''

Matches any sub-string in the title.

In this mode a window titled Untitled - Notepad would be matched by "Untitled - Notepad", "Untitled", "Notepad", "pad", "d - N", etc.

e.g.

<syntaxhighlight lang="sputnik">
WinWait("Notepad");
</syntaxhighlight>

'''Mode 4'''

Exact title match.

In this mode a window titled Untitled - Notepad would only be matched by "Untitled - Notepad"

e.g.

<syntaxhighlight lang="sputnik">
WinWait("Untitled - Notepad");
</syntaxhighlight>

'''Mode 5'''

Advanced mode.

Must be replaced with Advanced Window Descriptions which does not need any mode to be set.

'''Advanced Window Descriptions'''

A special description can be used as the window title parameter.

This description can be used to identify a window by the following properties:

* TITLE - Window title (If used on Title param however if used on Text param it will match against the found text rather than the title)
* CLASS - The internal window class name
* ACTIVE - Currently active window
* NOTACTIVE - This will not count the current active window in the search
* CLASSRX - Match class using a regular expression (Can be used on Title or Text params or both params to match the the given text of each param)
* REGEX - Match title or text using a regular expression (Can be used on Title or Text params or both params to match the the given text of each param)
* INSTANCE - The 1-based instance when all given properties match

One or more properties are used in the title parameter of a window command in the format:

<syntaxhighlight lang="sputnik">
[PROPERTY1=Value1; PROPERTY2=Value2]
</syntaxhighlight>

e.g. Wait a window of classname "Notepad"

<syntaxhighlight lang="sputnik">
WinWaitActive("[CLASS=Notepad]", "");
</syntaxhighlight>

e.g. Close the currently active window

<syntaxhighlight lang="sputnik">
WinClose("[ACTIVE]", "");
</syntaxhighlight>

e.g. Wait for the 2nd instance of a window with title "My Window" and classname "My Class"
<syntaxhighlight lang="sputnik">
WinWait("[TITLE=My Window; CLASS=My Class; INSTANCE=2]", "");
</syntaxhighlight>

e.g. Wait for the 2nd instance of a notepad
<syntaxhighlight lang="sputnik">
WinWait("[class=Notepad;INSTANCE=3]");
</syntaxhighlight>

e.g. List windows matching a classname defined by a regular expression

<syntaxhighlight lang="sputnik">
WinList("[CLASSRX=#\d+]")
</syntaxhighlight>

[[Category:Core Function]]

Core Function ThreadCreate

2011-12-04T19:53:21Z

Alexpja:

<pre>
ThreadCreate( <name>, <function> )
</pre>

=== Description ===

Create a new thread and start it off executing a function or some code

Sputnik supports multi-threading and you can create threads in your code to assist you.

Threads work best if you use them as *worker threads*.

=== Parameters ===

==== name ====

Name of a thread to create.

==== function ====

Either a function to call or a string to execute similar to Eval()

=== Return Value ===

Success: Returns 1.

Failure: Returns 0.

=== Remarks ===

You can spawn as many threads as you wish however there are a few important things to consider with threads.

* Threads can cause problems and even crash if used improperly.

* A thread works best if it's like a worker thread that is designed to get/set global variables and do its own thing and call functions here and there. Threads don't like to mess with every piece of code that you are messing with.

* Threads have their own stack and local variable that is independent from everything else they can however access global variables and functions etc.

* Threads don't like GUI stuff since most GUI functions are to be edited by the thread that created them therefore other threads aren't too happy if you make them mess with GUI of the main thread etc.

=== Example ===

<syntaxhighlight lang="sputnik">
ThreadCreate("th1", "Thread1Func();"); // This thread will execute a function
ThreadCreate("th2", "Thread2Func();"); // This thread will execute a function
ThreadCreate("th3", 'println("Thread 3 says hi");'); // This thread will execute code

inputc();

Function Thread1Func()
{
while(true)
{
println("Hello from thread '" . ThreadName() . "'");
sleep(500);
}
}

Function Thread2Func()
{
while(true)
{
println("Heya from thread '" . ThreadName() . "'");
sleep(500);
}
}
</syntaxhighlight>

[[Category:Core Function]]

Core Function Printf

2011-12-04T19:51:21Z

Alexpja:

<pre>
SPrintf( <expression>, <expressions>... )
</pre>

=== Description ===

Create a formatted string.

=== expression ===

The format string and flags to use (see Remarks).

==== expressions ====

Variables that will be output according to the "Format Control".

=== Return Value ===

Success: Returns the formatted string.

Failure: Returns an empty string.

=== Format Control ===

Something to note is that params are counted from 0 for example

Printf("format string", "param0", "param1", "param2", "param3")

And so on so to use param0 in the format string

"format {0}"

To use param 1

"format {1}"

To use param 0 and 3

"format {0} {3}"

Now after you enter the param number you can a place a : then special formats as shown below for example to print a hex number

Printf("{0:x4}\n", (int)1337)

See its using param 0 then : which means we want a special format then x to say we want to use a hex format then 4 to say we want the hex to be 4 chars long.

==== Strings ====

There really isn’t any formatting within a string, beyond it’s alignment. Alignment works for any argument being printed.

Example:

<syntaxhighlight lang="sputnik">
Printf("->{0,10}<-\n", "Hello")
Printf("->{0,-10}<-\n", "Hello")
; Generates
; -> Hello<-
; ->Hello <-
</syntaxhighlight>

==== Numbers ====

Basic number formatting specifiers:

{| border="1" align="left" style="text-align:center;"
|Specifier
|Type
|Format
|Output with (double)1.42
|Output with (int)1337
|Output with (int)-12400
|-
|c
|Currency
|{0:c}
|$1.42
|$1,337
| -$12,400
|-
|d
|Decimal (Whole number)
|{0:d}
|
|1337
| -12400
|-
|e
|Scientific
|{0:e}
|1.420000e+000
|1.337000e+003
| -1.240000e+004
|-
|f
|Fixed point
|{0:f}
|1.42
|1337.00
| -12400.00
|-
|g
|General
|{0:g}
|1.42
|1337
| -12400
|-
|n
|Number with commas for thousands
|{0:n}
|1.42
|1,337
| -12,400
|-
|r
|Round trippable
|{0:r}
|1.42
|
|
|-
|x
|Hexadecimal
|{0:x4}
|1.42
|0539
|cf90
|}

Custom number formatting:

{| border="1" align="left" style="text-align:center;"
|Specifier
|Type
|Example
|Output with (double)1500.42
|Note
|-
|0
|Zero placeholder
|{0:00.0000}
|1500.4200
|Pads with zeroes.
|-
|#
|Digit placeholder
|{0:(#).##}
|(1500).42
|
|-
|.
|Decimal point
|{0:0.0}
|1500.4
|
|-
|,
|Thousand separator
|{0:0,0}
|1,500
|Must be between two zeroes.
|-
|,.
|Number scaling
|{0:0,.}
|2
|Comma adjacent to Period scales by 1000.
|-
|%
|Percent
|{0:0%}
|150042%
|Multiplies by 100, adds % sign.
|-
|e
|Exponent placeholder
|{0:00e+0}
|15e+2
|Many exponent formats available.
|-
|;
|Group separator
|see below
|see below
|see below
|}

The group separator is especially useful for formatting currency values which require that negative values be enclosed in parentheses. This currency formatting example at the bottom of this document makes it obvious:

==== Dates ====

Note that date formatting is especially dependent on the system’s regional settings; the example strings here are from my local locale.

{| border="1" align="left" style="text-align:center;"
|Specifier
|Type
|Example (Passed @DateTimeNow)
|-
|d
|Short date
|10/12/2002
|-
|D
|Long date
|December 10, 2002
|-
|t
|Short time
|10:11 PM
|-
|T
|Long time
|10:11:29 PM
|-
|f
|Full date & time
|December 10, 2002 10:11 PM
|-
|F
|Full date & time (long)
|December 10, 2002 10:11:29 PM
|-
|g
|Default date & time
|10/12/2002 10:11 PM
|-
|G
|Default date & time (long)
|10/12/2002 10:11:29 PM
|-
|M
|Month day pattern
|December 10
|-
|r
|RFC1123 date string
|Tue, 10 Dec 2002 22:11:29 GMT
|-
|s
|Sortable date string
|2002-12-10T22:11:29
|-
|u
|Universal sortable, local time
|2002-12-10 22:13:50Z
|-
|U
|Universal sortable, GMT
|December 11, 2002 3:13:50 AM
|-
|Y
|Year month pattern
|December, 2002
|}

The ‘U’ specifier seems broken; that string certainly isn’t sortable.

==== Custom date formatting: ====

{| border="1" align="left" style="text-align:center;"
|Specifier
|Type
|Example
|Example Output
|-
|dd
|Day
|{0:dd}
|10
|-
|ddd
|Day name
|{0:ddd}
|Tue
|-
|dddd
|Full day name
|{0:dddd}
|Tuesday
|-
|f, ff, …
|Second fractions
|{0:fff}
|932
|-
|gg, ...
|Era
|{0:gg}
|A.D.
|-
|hh
|2 digit hour
|{0:hh}
|10
|-
|HH
|2 digit hour, 24hr format
|{0:HH}
|22
|-
|mm
|Minute 00-59
|{0:mm}
|38
|-
|MM
|Month 01-12
|{0:MM}
|12
|-
|MMM
|Month abbreviation
|{0:MMM}
|Dec
|-
|MMMM
|Full month name
|{0:MMMM}
|December
|-
|ss
|Seconds 00-59
|{0:ss}
|46
|-
|tt
|AM or PM
|{0:tt}
|PM
|-
|yy
|Year, 2 digits
|{0:yy}
|02
|-
|yyyy
|Year
|{0:yyyy}
|2002
|-
|zz
|Timezone offset, 2 digits
|{0:zz}
|-05
|-
|zzz
|Full timezone offset
|{0:zzz}
|-05:00
|-
|:
|Separator
|{0:hh:mm:ss}
|10:43:20
|-
|/
|Separator
|{0:dd/MM/yyyy}
|10/12/2002
|}

==== Enumerations ====

{| border="1" align="left" style="text-align:center;"
|Specifier
|Type
|-
|g
|Default (Flag names if available, otherwise decimal)
|-
|f
|Flags always
|-
|d
|Integer always
|-
|x
|Eight digit hex.
|}

==== Some Examples ====

<syntaxhighlight lang="sputnik">
Printf("{0:$#,##0.00;($#,##0.00);Zero}", 1243.50); // prints 1,243.50
</syntaxhighlight>

<syntaxhighlight lang="sputnik">
Printf("{0:(###) ###-####}", 8005551212); // prints (800) 555-1212
</syntaxhighlight>

===== How do I show numbers with 5 fixed digits with leading zeroes =====

<syntaxhighlight lang="sputnik">
$num1 = 123;
$num2 = 45;
$num3 = 123456;

Printf("{0:00000}\n", (int)$num1); // "00123"
Printf("{0:00000}\n", (int)$num2); // "00045"
Printf("{0:00000}\n", (int)$num3); // "123456"

Printf("{0:d5}\n", (int)$num1); // "00123"
Printf("{0:d5}\n", (int)$num2); // "00045"
Printf("{0:d5}\n", (int)$num3); // "123456"
</syntaxhighlight>

===== Substitute a string for a value =====

<syntaxhighlight lang="sputnik">
Printf("{0:yes;;no}\n", (int)1); // This will print "no" if value is 0, "yes" if value is 1.
Printf("{0:yes;;no}\n", (int)0); // This will print "no" if value is 0, "yes" if value is 1.
</syntaxhighlight>

===== How to format as percentage without having the number multiplied by 100 =====

<syntaxhighlight lang="sputnik">
Printf("{0:##.00'%}\n", 1.23); // This will yield "1.23%".
</syntaxhighlight>

===== How to use curly brackets within a formatted number =====

<syntaxhighlight lang="sputnik">
// Doubling them escapes them. For example:
Printf("{{SomeString}}={0}","Hello"); // will produce: "{SomeString}=Hellow"
</syntaxhighlight>

===== What’s a good way to format currency =====

<syntaxhighlight lang="sputnik">
$val = 4219.6;
Printf("{0:$#,#.00;Call Us;Call Us}", $val);
// This will return "$4,219.60". The .00 will force 2 decimals and the “;Call Us;Call Us” to show the text “Call Us” in place of negative and null values respectively. (Just in case)
</syntaxhighlight>

===== How to format an integer, with commas for thousands =====

<syntaxhighlight lang="sputnik">
Printf("{0:#,0}", (int)7770000); // 7,770,000
</syntaxhighlight>

===== How to format a phone number to look like 800.555.1212 =====

<syntaxhighlight lang="sputnik">
$tmp = SPrintf("{0:###-###-####}", "8005551212");
$result = Replace($tmp, "-",".");
println($result); // Prints 800.555.1212
</syntaxhighlight>

You could do it in one go example:

<syntaxhighlight lang="sputnik">
println(Replace(SPrintf("{0:###-###-####}", "8005551212"), "-",".")); // Prints 800.555.1212
</syntaxhighlight>

===== Convert a number with a thousand separator to an int =====

<syntaxhighlight lang="sputnik">
$num = "1,000,000";
$val = (int)Replace($num, ",", "");
println($val); // Prints 1000000 and $val is now an int
</syntaxhighlight>
===== Convert a number with a thousand separator to a double =====

<syntaxhighlight lang="sputnik">
$num = "1,000,000";
$val = (double)Replace($num, ",", "");
println($val); // Prints 1000000 and $val is now an double
</syntaxhighlight>

===== How to convert from currency back to a number =====

This is not the best way to do it but i suppose it will do for now

<syntaxhighlight lang="sputnik">
$currency = 1337;
$str = SPrintf("{0:c}", $currency); // Currency converted to string
$back = Replace(Replace(Replace($str, @CURRENCY, ""), ",", ""), ".", ""); // Currency converted back to string
println($str); // Print the currency
println($back); // Print the currency converted back to string
</syntaxhighlight>

=== Remarks ===

The console supports printing unicode however it's also possible that your choice of Console font does not support that particular character. Click on the Windows Toolbar Menu (icon like C:.) and select Properties -> Font. Try some other fonts to see if they display your character properly.

Warning: If you expect to use int, byte, float etc in the params then you must cast it as such for example:

<syntaxhighlight lang="sputnik">
$myint = 100;
$val = SPrintf("Value is 0x'{0:x}'", (int)$myint); // The (int) will only take in $myint

$myint = 100;
$myint2 = 100;
$val = SPrintf("Value is 0x'{0:x}'", (int)($myint + $myint2)); // The (int) will now take in $myint AND $myint2
</syntaxhighlight>
Note how $myint was cast as an int? using (int)$myint this is vital since if you dont do that it might send a string or a float you never really know with $variables so its best to cast it.

There is an alternative method example:

<syntaxhighlight lang="sputnik">
$myint = 100;
$val = SPrintf("Value is 0x'{0:x}'", int($myint));
</syntaxhighlight>

Its up to you to decide which one to use.

If you wish to capture the output of Printf to create strings:

Go see [[Core Function SPrintf|SPrintf( <expression>, <expressions>... )]] to Printf to strings.

Anything thats valid for Printf to print to console window is also valid for SPrintf to use to create strings.

=== Example ===

<syntaxhighlight lang="sputnik">
Printf("Value is 0x'{0:x}'", (int)100) ; Prints 0x64 since the {0:x} is telling it to place param 0 as :x meaning hex
</syntaxhighlight>

[[Category:Core Function]]

Core Function Println

2011-12-04T19:50:25Z

Alexpja:

<pre>
Println( <expression> )
</pre>

=== Description ===

Prints an expressions string value to the console window and inserts a newline character at the end

=== Parameters ===

==== Expression ====

The expression to print.

=== Return Value ===

None

=== Remarks ===

The console supports printing Unicode however it's also possible that your choice of Console font does not support that particular character. Click on the Windows Toolbar Menu (icon like C:.) and select Properties -> Font. Try some other fonts to see if they display your character properly.

All values including Ints will be printed as if it was a string.

=== Example ===

<syntaxhighlight lang="sputnik">
println("Line 1");
println("Line 2");
println("Line 3");
</syntaxhighlight>

[[Category:Core Function]]

Core Function Print

2011-12-04T19:49:52Z

Alexpja:

<pre>
Print( <expression> )
</pre>

=== Description ===

Prints an expressions string value to the console window

=== Parameters ===

==== Expression ====

The expression to print.

=== Return Value ===

None

=== Remarks ===

The console supports printing Unicode however it's also possible that your choice of Console font does not support that particular character. Click on the Windows Toolbar Menu (icon like C:.) and select Properties -> Font. Try some other fonts to see if they display your character properly.

All values including Ints will be printed as if it was a string.

=== Example ===

<syntaxhighlight lang="sputnik">
print("Testy");
</syntaxhighlight>

[[Category:Core Function]]

Core Function Regex Match

2011-12-04T19:49:16Z

Alexpja:

<pre>
<Expression> =~ m/pattern/flags
</pre>

=== Description ===

Match a string to a regular expression pattern and check if it matches and optionally return captured groups

=== Parameters ===

==== Expression ====

Any valid expression that is a string.

==== pattern ====

The regular expression pattern to match.

==== flags ====

Optional; The flags to use in the pattern.

i = Ignore case.

m = Treat the string as multiple lines.

s = Treat the string as a single line.

o = Do not recompile the regular expression after the first compile (Improves speed of your matches if you run the pattern many times).

g = Match all occurrences of the pattern in the string (Default is only match the first).

d = Return a single dimension array when using flag "g" (Default is to return a multidimensional array).

Note - If flag "g" is used the $_rg array will contain all matches from first to last it will not contain the text it matched it will only contain the matches, However if "g" is not used then the first element will be the matched text followed by all the matched groups 1 2 3 4 etc.

=== Return Value ===

Success: Returns 1 if the match was successful.

Failure: Returns 0.

=== Remarks ===

Note - The below is only for single matches not flag "g" matches.

If a regular expression pattern is matched correctly and it has capture groups in the pattern the groups will be set to local variables for example:

Group 0 will be $0.

Group 1 will be $1.

Group 2 will be $2.

And so on.

Of course captured NAMED groups will also be returned as follows:

Named group "Test" will be $_rg["Test"]

Named group "Moo" will be $_rg["Moo"]

Named group "Cat" will be $_rg["Cat"]

And so on.

After each regular expression match all capture groups from the previous match will be deleted so its best to copy them if you intend to keep using them.

==== Regular expressions ====

Regular expression notation is a compact way of specifying a pattern for strings that can be searched. Regular expressions are character strings in which plain text characters indicate what text should exist in the target string, and a some characters are given special meanings to indicate what variability is allowed in the target string. AutoIt regular expressions are normally case-sensitive.

Regular expressions are constructed of one or more of the following simple regular expression specifiers. If the character is not in the following table, then it will match only itself.

Repeating characters (*, +, ?, {...} ) will try to match the largest set possible, which allows the following characters to match as well, unless followed immediately by a question mark; then it will find the smallest pattern that allows the following characters to match as well.

Nested groups are allowed, but keep in mind that all the groups, except non-capturing groups, assign to the returned array, with the outer groups assigning after the inner groups.

===== Matching Characters =====

* [ ... ]
Match any character in the set. e.g. [aeiou] matches any lower-case vowel. A contiguous set can be defined using a dash between the starting and ending characters. e.g. [a-z] matches any lower case character. To include a dash (-) in a set, use it as the first or last character of the set. To include a closing bracket in a set, use it as the first character of the set. e.g. [][] will match either [ or ]. Note that special characters do not retain their special meanings inside a set, with the exception of \\, \^, \-,\[ and \] match the escaped character inside a set.
* [^ ... ]
Match any character not in the set. e.g. [^0-9] matches any non-digit. To include a caret (^) in a set, put it after the beginning of the set or escape it (\^).
* [:class:]
Match a character in the given class of characters. Valid classes are: alpha (any alphabetic character), alnum (any alphanumeric character), lower (any lower-case letter), upper (any upper-case letter), digit (any decimal digit 0-9), xdigit (any hexadecimal digit, 0-9, A-F, a-f), space (any white space character), blank (only a space or tab), print (any printable character), graph (any printable character except spaces), cntrl (any control character [ascii 127 or <32]) or punct (any punctuation character). So [0-9] is equivalent to [:digit:].
* [^:class:]
Match any character not in the class, but only if the first character.
* ( ... )
Group. The elements in the group are treated in order and can be repeated together. e.g. (ab)+ will match "ab" or "abab", but not "aba". A group will also store the text matched for use in back-references and in the array returned by the function, depending on flag value.
* (?i)
Case-insensitivity flag. This does not operate as a group. It tells the regular expression engine to do case-insensitive matching from that point on.
* (?-i) (default)
Case-sensitivity flag. This does not operate as a group. It tells the regular expression engine to do case-sensitive matching from that point on.
* (?i ... )
Case-insensitive group. Behaves just like a normal group, but performs case-insensitive matches within the group.
* (?-i ... )
Case-sensitive group. Behaves just like a normal group, but performs case-sensitive matches within the group. Primarily for use after (-i) flag or inside a case-insensitive group.
* (?: ... )
Non-capturing group. Behaves just like a normal group, but does not record the matching characters in the array nor can the matched text be used for back-referencing.
* (?i: ... )
Case-insensitive non-capturing group. Behaves just like a non-capturing group, but performs case-insensitive matches within the group.
* (?-i: ... )
Case-sensitive non-capturing group. Behaves just like a non-capturing group, but performs case-sensitive matches within the group.
* (?m)
^ and $ match newlines within data.
* (?s)
. matches anything including newline. (by default "." don't match newline)
* (?x)
Ignore white space and # comments.
* (?U)
Invert greediness of quantifiers.
* .
Match any single character (except newline).
* |
Or. The expression on one side or the other can be matched.
* \
Escape a special character (have it match the actual character) or introduce a special character type (see below).
* \\
Match an actual backslash (\).
* \a
Alarm, that is, the BEL character (chr(7)).
* \A
Match only at beginning of string.
* \b
Matches at a word boundary.
* \B
Matches when not at a word boundary.
* \c
Match a control character, based on the next character. For example, \cM matches ctrl-M.
* \d
Match any digit (0-9).
* \D
Match any non-digit.
* \e
Match an escape character (chr(27)).
* \E
end case modification.
* \f
Match an form feed character (chr(12)).
* \h
any horizontal white space character.
* \H
any character that is not a horizontal white space character.
* \n
Match a linefeed (@LF, chr(10)).
* \Q
quote (disable) pattern meta characters till \E.
* \r
Match a carriage return (@CR, chr(13)).
* \s
Match any white space character: Chr(9) through Chr(13) which are Horizontal Tab, Line Feed, Vertical Tab, Form Feed, and Carriage Return, and the standard space ( Chr(32) ).
* \S
Match any non-white space character.
* \t
Match a tab character (chr(9)).
* \v
any vertical white space character.
* \V
any character that is not a vertical white space character.
* \w
Match any "word" character: a-z, A-Z, 0-9 or underscore (_).
* \W
Match any non-word character.
* \###
Match the ascii character whose code is given or back-reference. Can be up to 3 octal digits.
Match back-reference if found. Match the prior group number given exactly. For example, ([:alpha:])\1 would match a double letter.
* \x##
Match the ascii character whose code is given in hexadecimal. Can be up to 2 digits.
* \z
Match only at end of string.
* \Z
Match only at end of string, or before newline at the end.

===== Repeating Characters =====

* {x}
Repeat the previous character, set or group exactly x times.
* {x,}
Repeat the previous character, set or group at least x times.
* {0,x}
Repeat the previous character, set or group at most x times.
* {x, y}
Repeat the previous character, set or group between x and y times, inclusive.
* *
Repeat the previous character, set or group 0 or more times. Equivalent to {0,}
* +
Repeat the previous character, set or group 1 or more times. Equivalent to {1,}
* ?
The previous character, set or group may or may not appear. Equivalent to {0, 1}
* ?
(after a repeating character) Find the smallest match instead of the largest.

=== Example ===

Check if a string matches a given pattern :

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = "Hello, World!";

if( $str =~ m/\w+,\s+\w+!/ )
{
println("True");
}
else
{
println("False");
}
</syntaxhighlight>

Check if a string matches a given pattern case insensitive :

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = "Hello, World!";

if( $str =~ m/hello,\s+WORLD!/i )
{
println("True");
}
else
{
println("False");
}
</syntaxhighlight>

Simple matching a string and returning 2 captured groups :

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = 'Account Test Credits 777';

// Do the regex match
$str =~ m/Account\s+(\w+)\s+\w+\s+(\d+)/i;

println("Account '$1' Credits '$2'");
// Prints
// Account 'Test' Credits '777'
</syntaxhighlight>

Simple matching a string and returning 2 captured groups and saving the variables:

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = 'Account Test Credits 777';

// Do the regex match
$str =~ m/Account\s+(\w+)\s+\w+\s+(\d+)/i;

$Account = $1;
$Credits = $2;

println("Account '$Account' Credits '$Credits'");
// Prints
// Account 'Test' Credits '777'
</syntaxhighlight>

Same thing but this time parsing multiple lines of accounts :

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = 'Account Test Credits 777' . @CRLF;
$str .= 'Account FoX Credits 1337' . @CRLF;
$str .= 'Account Cat Credits 100' . @CRLF;
$str .= 'Account Dog Credits 50' . @CRLF;

// Do the regex match
$str =~ m/Account\s+(\w+)\s+\w+\s+(\d+)/ig;

// Print them all
for($i = 0; $i < @Groups; $i++)
{
$Account = $_rg[$i, 1];
$Credits = $_rg[$i, 2];
println("Match ($i) | Account '" . $Account . "' | Credits '" . $Credits . "'" );
}
// Prints
// Match (0) | Account 'Test' | Credits '777'
// Match (1) | Account 'FoX' | Credits '1337'
// Match (2) | Account 'Cat' | Credits '100'
// Match (3) | Account 'Dog' | Credits '50'
</syntaxhighlight>

Case insensitive match on a string to capture all possible matches and return them as a multi-dimensional array :

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = '<test>a</test> <test>b</test> <test>c</Test>';

// Do the regex match
$str =~ m/<(?i)test>(.*?)<\/(?i)test>/ig;

// How many groups did we find?
println("Found groups: " . @Groups);

// Print them all
for($i = 0; $i < @Groups; $i++)
{
$match = $_rg[$i];
println("Match ($i) | Text '" . $match[0] . "' | Group text '" . $match[1] . "'" );
}
// Prints
// Found groups: 3
// Match (0) | Text '<test>a</test>' | Group text 'a'
// Match (1) | Text '<test>b</test>' | Group text 'b'
// Match (2) | Text '<test>c</Test>' | Group text 'c'
</syntaxhighlight>

Case insensitive match on a string to capture all possible matches and return them as a single dimension array :

<syntaxhighlight lang="sputnik">
// Set a string to parse
$str = '<test>a<\/test> <test>b</test> <test>c</Test>';

// Do the regex match
$str =~ m/<(?i)test>(.*?)</(?i)test>/igd;

// How many groups did we find?
println("Found groups: " . @Groups);

// Print them all
for($i = 0; $i < @Groups; $i++)
{
println("Match ($i) | Group text '" . $_rg[$i] . "'" );
}
// Prints
// Found groups: 3
// Match (0) | Group text 'a'
// Match (1) | Group text 'b'
// Match (2) | Group text 'c'
</syntaxhighlight>

[[Category:Core Function]]

Core Function Regex Replace

2011-12-04T19:48:05Z

Alexpja:

<pre>
<Expression> =~ s/pattern/replacement/flags
</pre>

=== Description ===

Replace parts of a string using a regular expression pattern and optionally executing functions on the matched groups

=== Parameters ===

==== Expression ====

Any valid expression that is a string.

==== pattern ====

The regular expression pattern to match.

==== pattern ====

A string to replace the match(es) with.

==== flags ====

Optional; The flags to use in the pattern.

i = Ignore case.

m = Treat the string as multiple lines.

s = Treat the string as a single line.

o = Do not recompile the regular expression after the first compile (Improves speed of your matches if you run the pattern many times).

g = Match all occurrences of the pattern in the string (Default is only match the first).

e = Treat the replace string as actual Sputnik code similar to Eval().

=== Return Value ===

Success: Returns the modified string.

Failure: Returns an empty string.

=== Remarks ===

See regex match for details on regex.

=== Example ===

A simple search replace

<syntaxhighlight lang="sputnik">
// A string to use
$var = "That cat is cute but this cat is not";

// Replace cat with dog
$var =~ s/cat/dog/;

println( $var );
</syntaxhighlight>

Same again but this time replace all using the "g" switch

<syntaxhighlight lang="sputnik">
// A string to use
$var = "That cat is cute but this cat is not";

// Replace cat with dog
$var =~ s/cat/dog/g;

println( $var );
</syntaxhighlight>

Same again but this time ignore case using the "i" switch
<syntaxhighlight lang="sputnik">
// A string to use
$var = "That cat is cute but this Cat is not";

// Replace cat with dog
$var =~ s/cat/dog/gi;

println( $var );
</syntaxhighlight>

Search the string and reverse the order so stuff after the = now comes before it
<syntaxhighlight lang="sputnik">
// A string to use
$var = "One=100\n";
$var .= "Two=200\n";
$var .= "Three=300\n";

$var =~ s/(\w+)=(\w+)/$2=$1/gi;

println( $var );
</syntaxhighlight>

Execute the replace as a function using the "e" switch and increase all numbers in the string by 1
<syntaxhighlight lang="sputnik">
// A string to use
$var = "10 20 30 40 50 60 70 80 90 100";

$var =~ s/(\d+)/$1++/egi;

println( $var ); // Prints 11 21 31 41 51 61 71 81 91 101
</syntaxhighlight>

Take a string containing floating point numbers and convert them to integers using floor()
<syntaxhighlight lang="sputnik">
// A string to use
$var = "10.2 300.45 133.77";

$var =~ s/(\d+\.\d*)/floor($1)/egi; // Prints 10 300 133

println( $var );
</syntaxhighlight>

Convert a string to hex and back again using switch "e" on a regex to decode the hex
<syntaxhighlight lang="sputnik">
$hex = Unpack("*H", "Hello World!", 1);
println("Hex String: " . $hex);
$hex =~ s/([\dA-Fa-f][\dA-Fa-f])/Chr(Dec($1))/ego;
println("Normal String: " . $hex);
</syntaxhighlight>

Here we use regex to decode a QUERY_STRING and resolve the key, values into a hashmap Request[]
<syntaxhighlight lang="sputnik">
Glob $Request = array();
{
$QueryString = EnvGet("QUERY_STRING");
$QueryList = Split($QueryString, '&');
Foreach($QueryList as $i)
{
List ( $Key, $Value ) = Split($i, '=');
$Value =~ s/%([a-fA-F0-9][a-fA-F0-9])/Chr(Dec($1))/ego;
$Value =~ s/\+/ /gi;
$Value =~ s/\</</gi;
$Value =~ s/\>/>/gi;
$Request[$Key] = $Value;
}
}
</syntaxhighlight>
[[Category:Core Function]]

What is Sputnik

2011-11-30T04:25:47Z

Alexpja:

Sputnik is a somewhat new programming language I (UberFoX) made to bridge the gap between having to use 3 languages (AutoIt, PHP, Perl) it was intended to be just used by me to do some scripting but i see no reason not to share if others want to try it too.

----

The idea was to get all macro functionality of AutoIt with ease and what not of Perl with the easier syntax of PHP and its' nice built-in functions.

Obviously, making a programming language or even a small scripting language is a great effort and forever ongoing!

----

The result so far, is Sputnik: a language with a pseudo Perl/PHP syntax with macro/keyboard/mouse/hotkey functionality of AutoIt, regexes similar to Perl, classes similar to C++, yet simplified and still pretty powerful (supporting multiple inheritance and every operator overload and casting overload), multi-threading, and ability to make GUI programs.

There is still mountains to go, and we are only barely starting with Sputnik.

----
Currently, Sputnik is a bit messy, disorganized, and far from being a 1.0 final version. Sputnik has been developed to around 7% of the final product, and at the moment, there is a long way to go! But, it is useable and if you find any bugs, let us know.

Also, if you like Sputnik and want to know more, let us know.

Core Function FileOpenDialog

2011-11-28T12:44:48Z

Alexpja: /* options */

<pre>
FileOpenDialog ( <title>, <dir>, <filter>, <options>, <default name> )
</pre>

=== Description ===

Initiates a Load File Dialog.

=== Parameters ===

==== title ====

Title text of the Dialog GUI.

==== dir ====

Initial directory selected in the GUI file tree.

==== filter ====

File type filter such as "All (*.*)" or "Text files (*.txt)"

==== options ====

Optional;
<pre>
[optional] Dialog Options: To use more than one option, use a + sign to separate them (eg: 1 + 4).
1 = File Must Exist (if user types a filename)
2 = Path Must Exist (if user types a path)
4 = Allow MultiSelect
8 = Prompt to Create New File (if does not exist)
16 = Prompt to OverWrite File (see FileSaveDialog)
</pre>

==== default name ====

Optional; File name to suggest to the user to save the file with.

=== Return Value ===

Success: Returns the full path of the file(s) chosen. Results for multiple selections are "Directory|file1|file2|..."

Failure: Returns empty string.

=== Remarks ===

Separate the file filters with a semicolon as shown in the example.

Note: At this time, multiple groups of filters are not supported.

If default name is given, options must also be given. If none of the options are wanted, use 0 for options.

Special Windows folders (such as "My Documents") can be sometimes be set as the init dir.

=== Example ===

<syntaxhighlight lang="sputnik">
$message = "Hold down Ctrl or Shift to choose multiple files.";

$var = FileOpenDialog($message, @WinDir, "Images (*.jpg;*.bmp)", 1 + 4 );

If (!$var)
{
MsgBox("No File(s) chosen");
}
Else
{
$var = Replace($var, "|", @CRLF);
MsgBox("You chose $var");
}
</syntaxhighlight>

[[Category:Core Function]]

Core Function WinKill

2011-11-28T12:39:34Z

Alexpja: /* Remarks */

<pre>
WinKill ( <title>, <text> )
</pre>

=== Description ===

Forces a window to close.

=== Parameters ===

==== Title ====

The title of the window.

=== Return Value ===

None.

=== Remarks ===

The difference between this function and WinClose is that WinKill will forcibly terminate the window if it doesn't close quickly enough. Consequently, a user might not have time to respond to dialogs prompting the user to save data.

Although WinKill can work on both minimized and hidden windows, some windows (notably Windows Explorer) can only be terminated using WinClose.

See "WinTitleMatchMode" in [[Core Function Opt|Opt]].

=== Example ===

<syntaxhighlight lang="sputnik">
WinKill("Untitled - Notepad", "");
</syntaxhighlight>

[[Category:Core Function]]

Function Reference

2011-11-28T00:45:46Z

Alexpja: /* Math Functions */

Core Function Min

2011-11-28T00:45:25Z

Alexpja:

<pre>
Min( <expression>, <expression2> )
</pre>

=== Description ===

Find the lesser number and return it

=== Parameters ===

==== expression ====

Any valid numeric expression.

==== expression2 ====

Any valid numeric expression.

=== Return Value ===

Compares 2 numbers and returns the lowest number.

=== Remarks ===

None.

=== Example ===

<syntaxhighlight lang="sputnik">
$y = min(50, 100);
println( "Value is: $y " ); //prints 50
</syntaxhighlight>

[[Category:Core Function]]

Function Reference

2011-11-28T00:15:50Z

Alexpja: /* Math Functions */

Core Function Min

2011-11-28T00:14:57Z

Alexpja: Created page with "<pre> Min( <expression>, <expression2> ) </pre> === Description === Find the lowest number and return it === Parameters === ==== expression ==== Any valid numeric expression..."

<pre>
Min( <expression>, <expression2> )
</pre>

=== Description ===

Find the lowest number and return it

=== Parameters ===

==== expression ====

Any valid numeric expression.

==== expression2 ====

Any valid numeric expression.

=== Return Value ===

Compares 2 numbers and returns the lowest number.

=== Remarks ===

None.

=== Example ===

<syntaxhighlight lang="sputnik">
$y = min(50, 100);
println( "Value is: $y " ); //prints 50
</syntaxhighlight>

[[Category:Core Function]]

Core Function Split

2011-11-27T19:21:40Z

Alexpja:

<pre>
Split( <expression>, <delim/pattern>, <flag> )
</pre>

=== Description ===

Splits up a string into substrings depending on the given delimiters.

OR

Splits up a string into substrings depending on the given RegExp pattern.

=== Parameters ===

==== expression ====

The string to evaluate.

==== delim/pattern ====

One or more characters to use as delimiters (case sensitive).

OR

A RegExp match pattern (The pattern is very similar to perl and layed out the same way).

==== flag ====

Warning: You can only use the flag if you are NOT using a RegExp pattern as the Delim.

Optional; Changes how the string split works:
flag = 0 (default), each character in the delimiter string will mark where to split the string.
flag = 1, entire delimiter string is needed to mark where to split the string.

=== Return Value ===

Returns an array with each elment ($array[0], $array[1], etc.) contain the delimited strings.

If no delimiters were found an empty array will be returned.

=== Remarks ===

If you use a blank string "" for the delimiters, each character will be returned as an element.

If you use a blank RegExp m// for the delim, each character will be returned as an element.

If the delimiter you wish to use is a substring instead of individual single characters, see the example below.

Split is very useful as an alternative to InStr and as a means to populate an array.

Caution if you use the macro @CRLF you are referring to a 2 character string so you will generate extra blanks lines.

=== Example ===

To split a string at each , example:

<syntaxhighlight lang="sputnik">
$days = Split("Sun,Mon,Tue,Wed,Thu,Fri,Sat", ",");
Foreach( $days as $day )
{
println("Element is: " . $day);
}
</syntaxhighlight>

To split a string at each letter example:

<syntaxhighlight lang="sputnik">
$letters = Split("The quick brown FoX", "");
Foreach ( $letters as $letter )
{
println("Element is: " . $letter);
}
</syntaxhighlight>

To split a string every time it finds the word "moo" example:

<syntaxhighlight lang="sputnik">
$array = Split("This moo is a string moo ok", "moo", 1);
Foreach ( $array as $elem )
{
println("Element is: " . $elem);
}
</syntaxhighlight>

You can place the Split directly in the For loop example:

<syntaxhighlight lang="sputnik">
Foreach ( Split("This moo is a string moo ok", "moo", 1) as $elem )
{
println("Element is: " . $elem);
}
</syntaxhighlight>

To split the string each time a "<" followed by digits followed by a ">" is found using a RegExp pattern example:

<syntaxhighlight lang="sputnik">
$str = Split("The<12>quick<46>brown<68>fox....", m/<\d+>/);
Foreach ( $str as $elem )
{
println("Element is: " . $elem);
}
</syntaxhighlight>

Of course you can place the split in the For example:

<syntaxhighlight lang="sputnik">
Foreach ( Split("The<12>quick<46>brown<68>fox....", m/<\d+>/) as $elem )
{
println("Element is: " . $elem);
}
</syntaxhighlight>

To see what more patterns you can match go see Regex Match or RegExp functions and read the Remarks.

[[Category:Core Function]]

Core Function MsgBox

2011-11-27T06:46:49Z

Alexpja: /* Remarks */

<pre>
MsgBox( <message>, <title>, <flag>, <timeout> )
</pre>

=== Description ===

Returns a string representation of an integer type converted to hexadecimal.

=== Parameters ===

==== message ====

The text of the message box.

==== title ====

The title of the message box.

The default title is "MessageBox".

==== flag ====

Optional; The flag indicates the type of message box and the possible button combinations. See remarks.

Default 64 (Information).

==== timeout ====

Optional; Timeout in seconds. After the timeout has elapsed the message box will be automatically closed.

=== Return Value ===

Success: Returns the ID of the button pressed.

Failure: Returns -1 if the message box timed out.

<pre>
Button Pressed Return Value
OK 1
CANCEL 2
ABORT 3
RETRY 4
IGNORE 5
YES 6
NO 7
TRY AGAIN 10
CONTINUE 11
</pre>

=== Remarks ===

The flag parameter can be a combination of the following values:

<pre>
decimal flag Button-related Result Hexadecimal flag
0 OK button 0x0
1 OK and Cancel 0x1
2 Abort, Retry, and Ignore 0x2
3 Yes, No, and Cancel 0x3
4 Yes and No 0x4
5 Retry and Cancel 0x5
6 Cancel, Try Again, Continue 0x6

decimal flag Icon-related Result Hexadecimal flag
0 (No icon) 0x0
16 Stop-sign icon 0x10
32 Question-mark icon 0x20
48 Exclamation-point icon 0x30
64 Icon consisting of an 'i' in a circle 0x40

decimal flag Default-related Result Hexadecimal flag
0 First button is default button 0x0
256 Second button is default button 0x100
512 Third button is default button 0x200

decimal flag Modality-related Result Hexadecimal flag
0 Application 0x0
4096 System modal (dialog has an icon) 0x1000
8192 Task modal 0x2000

decimal flag Miscellaneous-related Result Hexadecimal flag
0 (nothing else special) 0x0
262144 MsgBox has top-most attribute set 0x40000
524288 title and text are right-justified 0x80000
</pre>

=== Example ===

<syntaxhighlight lang="sputnik">
MsgBox("My Message");
MsgBox("My Message", "My Title");
MsgBox("My Message", "My Title", 32);
MsgBox("My Message", "My Title", 32, 3);

// Example making a messagebox with question message and a yes no then get the result
$Result = MsgBox("My Message", "My Title", 32 | 4); // Binary operator
If ( $Result == 6 ) // Yes
{
MsgBox("You pressed yes");
}
Else If ( $Result == 7 ) // No
{
MsgBox("You pressed no");
}
else
{
MsgBox("Im not sure what you pressed....");
}

</syntaxhighlight>

[[Category:Core Function]]

Core Function MsgBox

2011-11-27T06:11:46Z

Alexpja: /* Remarks */

Function Reference

2011-11-27T01:10:27Z

Alexpja: /* Other GUI Functions */

Core Function Random

2011-11-27T01:08:52Z

Alexpja:

<pre>
Random( <expression>, <expression2> )
</pre>

=== Description ===

Get a random number from the defined area.

=== expression ===

A number, or a variable containing a number.

<syntaxhighlight lang="sputnik">
$var = 5;
</syntaxhighlight>

=== expression2 ===

A number, or a variable containing a number.

<syntaxhighlight lang="sputnik">
$var2 = 33;
</syntaxhighlight>

=== Return Value ===

Success: Returns a random number.
Failure: Does not return a random number (if an expression is not properly defined).

==== Some Examples ====

<syntaxhighlight lang="sputnik">
$var = 5; // first expression
$var2 = 33; // second expression
$ran = Random($var, $var2); // function in variable
printf($ran); // print a random number from $ran
</syntaxhighlight>

[[Category:Core Function]]

Core Function InputBox

2011-11-27T01:08:34Z

Alexpja:

<pre>
InputBox( <title>, <message>, <default text> )
</pre>

=== Description ===

Shows a box to input text.

=== Parameters ===

==== title ====

The title of the input box.

==== message ====

The message asking the user in the input box.

==== default text ====

The default text that appears in the text box of the input box.

=== Return Value ===

Success: Returns the text inputted in the text box.
Failure: Returns blank.

=== Examples ===

<syntaxhighlight lang="sputnik">
$Form = InputBox("Hello!", "What is your name?", "");
MsgBox("Your name is ".$Form."!", "Hello!");
</syntaxhighlight>

[[Category:Core Function]]

Core Function InputBox

2011-11-27T01:08:21Z

Alexpja: Created page with "<pre> InputBox( <title>, <message>, <default text> ) </pre> === Description === Shows a box to input text. === Parameters === ==== title ==== The title of the input box. ==..."

The Team

2011-11-27T00:31:56Z

Alexpja:

* UberFox
** Head Developer

* T3charmy
** Side Developer
** Wiki Editor

* Alexpja
** Wiki Editor

Core Function MsgBox

2011-11-26T23:16:48Z

Alexpja:

Core Function MsgBox

2011-11-26T22:52:59Z

Alexpja:

<pre>
MsgBox( <message>, <title>, <flag>, <timeout> )
</pre>

=== Description ===

Returns a string representation of an integer type converted to hexadecimal.

=== Parameters ===

==== message ====

The text of the message box.

==== title ====

The title of the message box.

Default "MessageBox".

==== flag ====

Optional; The flag indicates the type of message box and the possible button combinations. See remarks.

Default 0.

==== timeout ====

Optional; Timeout in seconds. After the timeout has elapsed the message box will be automatically closed.

=== Return Value ===

Success: Returns the ID of the button pressed.

Failure: Returns -1 if the message box timed out.

<pre>
Button Pressed Return Value
OK 1
CANCEL 2
ABORT 3
RETRY 4
IGNORE 5
YES 6
NO 7
TRY AGAIN 10
CONTINUE 11
</pre>

=== Remarks ===

The flag parameter can be a combination of the following values:

<pre>
decimal flag Button-related Result Hexadecimal flag
0 OK button 0x0
1 OK and Cancel 0x1
2 Abort, Retry, and Ignore 0x2
3 Yes, No, and Cancel 0x3
4 Yes and No 0x4
5 Retry and Cancel 0x5
6 Cancel, Try Again, Continue 0x6

decimal flag Icon-related Result Hexadecimal flag
0 (No icon) 0x0
16 Stop-sign icon 0x10
32 Question-mark icon 0x20
48 Exclamation-point icon 0x30
64 Icon consisting of an 'i' in a circle 0x40

decimal flag Default-related Result Hexadecimal flag
0 First button is default button 0x0
256 Second button is default button 0x100
512 Third button is default button 0x200

decimal flag Modality-related Result Hexadecimal flag
0 Application 0x0
4096 System modal (dialog has an icon) 0x1000
8192 Task modal 0x2000

decimal flag Miscellaneous-related Result Hexadecimal flag
0 (nothing else special) 0x0
262144 MsgBox has top-most attribute set 0x40000
524288 title and text are right-justified 0x80000
</pre>

=== Example ===

<syntaxhighlight lang="sputnik">
MsgBox("My Message");
MsgBox("My Message", "My Title");
MsgBox("My Message", "My Title", 32);
MsgBox("My Message", "My Title", 32, 3);

// Example making a messagebox with question message and a yes no then get the result
$Result = MsgBox("My Message", "My Title", 32 | 4); // Binary operator
If ( $Result == 6 ) // Yes
{
MsgBox("You pressed yes");
}
Else If ( $Result == 7 ) // No
{
MsgBox("You pressed no");
}
else
{
MsgBox("Im not sure what you pressed....");
}

</syntaxhighlight>

[[Category:Core Function]]

Core Function MsgBox

2011-11-26T22:52:09Z

Alexpja:

<pre>
MsgBox( <message>, <title>, <flag>, <timeout> )
</pre>

=== Description ===

Returns a string representation of an integer type converted to hexadecimal.

=== Parameters ===

==== message ====

The text of the message box.

==== title ====

The title of the message box.

Default "MessageBox".

==== flag ====

Optional; The flag indicates the type of message box and the possible button combinations. See remarks.

Default 0.

==== timeout ===

Optional; Timeout in seconds. After the timeout has elapsed the message box will be automatically closed.

=== Return Value ===

Success: Returns the ID of the button pressed.

Failure: Returns -1 if the message box timed out.

<pre>
Button Pressed Return Value
OK 1
CANCEL 2
ABORT 3
RETRY 4
IGNORE 5
YES 6
NO 7
TRY AGAIN 10
CONTINUE 11
</pre>

=== Remarks ===

The flag parameter can be a combination of the following values:

<pre>
decimal flag Button-related Result Hexadecimal flag
0 OK button 0x0
1 OK and Cancel 0x1
2 Abort, Retry, and Ignore 0x2
3 Yes, No, and Cancel 0x3
4 Yes and No 0x4
5 Retry and Cancel 0x5
6 Cancel, Try Again, Continue 0x6

decimal flag Icon-related Result Hexadecimal flag
0 (No icon) 0x0
16 Stop-sign icon 0x10
32 Question-mark icon 0x20
48 Exclamation-point icon 0x30
64 Icon consisting of an 'i' in a circle 0x40

decimal flag Default-related Result Hexadecimal flag
0 First button is default button 0x0
256 Second button is default button 0x100
512 Third button is default button 0x200

decimal flag Modality-related Result Hexadecimal flag
0 Application 0x0
4096 System modal (dialog has an icon) 0x1000
8192 Task modal 0x2000

decimal flag Miscellaneous-related Result Hexadecimal flag
0 (nothing else special) 0x0
262144 MsgBox has top-most attribute set 0x40000
524288 title and text are right-justified 0x80000
</pre>

=== Example ===

<syntaxhighlight lang="sputnik">
MsgBox("My Message");
MsgBox("My Message", "My Title");
MsgBox("My Message", "My Title", 32);
MsgBox("My Message", "My Title", 32, 3);

// Example making a messagebox with question message and a yes no then get the result
$Result = MsgBox("My Message", "My Title", 32 | 4); // Binary operator
If ( $Result == 6 ) // Yes
{
MsgBox("You pressed yes");
}
Else If ( $Result == 7 ) // No
{
MsgBox("You pressed no");
}
else
{
MsgBox("Im not sure what you pressed....");
}

</syntaxhighlight>

[[Category:Core Function]]

Core Function MsgBox

2011-11-26T22:40:13Z

Alexpja:

<pre>
MsgBox( <expression> )
</pre>

=== Description ===

Show a message dialog.

=== expression ===

With a string:

<syntaxhighlight lang="sputnik">
MsgBox("Hello.");
</syntaxhighlight>

With a variable:

<syntaxhighlight lang="sputnik">
$testing = "Kittens";
MsgBox($testing);
</syntaxhighlight>

==== Some Examples ====

Core Function MsgBox

2011-11-26T22:38:58Z

Alexpja: Created page with "<pre> MsgBox( <expression> ) </pre> === Description === Show a message dialog. === Usage === With a string: <syntaxhighlight lang="sputnik"> MsgBox("Hello."); </syntaxhighli..."

<pre>
MsgBox( <expression> )
</pre>

=== Description ===

Show a message dialog.

=== Usage ===

With a string:

<syntaxhighlight lang="sputnik">
MsgBox("Hello.");
</syntaxhighlight>

With a variable:

<syntaxhighlight lang="sputnik">
$testing = "Kittens";
MsgBox($testing);
</syntaxhighlight>

==== Some Examples ====

Core Function Random

2011-11-26T22:18:43Z

Alexpja: /* Some Examples */

Function Reference

2011-11-26T22:18:21Z

Alexpja: /* Math Functions */

Core Function Random

2011-11-26T22:17:41Z

Alexpja: Created page with "<pre> Random( <expression>, <expression2> ) </pre> === Description === Get a random number from the defined area. === expression === A number, or a variable containing a numb..."

<pre>
Random( <expression>, <expression2> )
</pre>

=== Description ===

Get a random number from the defined area.

=== expression ===

A number, or a variable containing a number.

<syntaxhighlight lang="sputnik">
$var = 5;
</syntaxhighlight>

=== expression2 ===

A number, or a variable containing a number.

<syntaxhighlight lang="sputnik">
$var2 = 33;
</syntaxhighlight>

=== Return Value ===

Success: Returns a random number.
Failure: Does not return a random number (if an expression is not properly defined).

==== Some Examples ====

<syntaxhiglight lang="sputnik">
$var = 5; // first expression
$var2 = 33; // second expression
$ran = Random($var, $var2); // function in variable
printf($ran); // print a random number from $ran
</syntaxhighlight>