Class Reference

2011-11-26T23:35:51Z

T3charmy: Created page with "Coming Soon!"

Coming Soon!

Function Reference

2011-11-23T22:36:17Z

T3charmy: /* String 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

==== 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

==== Multithreading 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

===== 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

==== 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 BitAND|BitAND( <expression> )]] --
* [[Core Function BitNOT|BitNOT( <expression> )]] --
* [[Core Function BitOR|BitOR( <expression> )]] --
* [[Core Function BitROTATE|BitROTATE( <expression> )]] --
* [[Core Function BitSHIFT|BitSHIFT( <value>, <shift> )]] -- Performs a bit shifting operation
* [[Core Function BitXOR|BitXOR( <expression> )]] --
* [[Core Function Ceiling|Ceiling( <expression> )]] --
* [[Core Function Cos|Cos( <expression> )]] --
* [[Core Function Cosh|Cosh( <expression> )]] --
* [[Core Function Exp|Exp( <expression> )]] --
* [[Core Function Floor|Floor( <expression> )]] --
* [[Core Function Log|Log( <expression> )]] --
* [[Core Function Math|Math( <expression> )]] --
* [[Core Function Max|Max( <expression>, <expression2> )]] -- Find the greater number and return it
* [[Core Function Min|Min( <expression> )]] --
* [[Core Function Mod|Mod( <expression> )]] --
* [[Core Function Pow|Pow( <expression> )]] --
* [[Core Function Random|Random( <expression> )]] --
* [[Core Function Round|Round( <expression> )]] --
* [[Core Function Sin|Sin( <expression> )]] --
* [[Core Function Sinh|Sinh( <expression> )]] --
* [[Core Function Sqrt|Sqrt( <expression> )]] --
* [[Core Function Tan|Tan( <expression> )]] --
* [[Core Function Tanh|Tanh( <expression> )]] --
* [[Core Function Turncate|Turncate( <expression> )]] --

==== String Functions ====
* [[Core Function Asc|Asc( <expression> )]] --
* [[Core Function AscW|AscW( <expression> )]] --
* [[Core Function Chr|Chr( <expression> )]] --
* [[Core Function ChrW|ChrW( <expression> )]] --
* [[Core Function Contains|Contains( <expression> )]] --
* [[Core Function Compare|Compare( <expression> )]] --
* [[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 EndsWith|EndsWith( <expression> )]] --
* [[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> )]] --
* [[Core Function isAlphaNumeric|isAlphaNumeric( <expression> )]] --
* [[Core Function isASCII|isASCII( <expression> )]] --
* [[Core Function isEmpty|isEmpty( <expression> )]] -- Checks if a string is completely empty.
* [[Core Function isFloat|isFloat( <expression> )]] --
* [[Core Function isLower|isLower( <expression> )]] --
* [[Core Function isNumeric|isNumeric( <expression> )]] --
* [[Core Function isSpace|isSpace( <expression> )]] --
* [[Core Function isSymbol|isSymbol( <expression> )]] --
* [[Core Function isUpper|isUpper( <expression> )]] --
* [[Core Function isXDigit|isXDigit( <expression> )]] --
* [[Core Function LC|LC( <expression> )]] --
* [[Core Function LCFirst|LCFirst( <expression> )]] --
* [[Core Function LCWords|LCWords( <expression> )]] --
* [[Core Function Left|Left( <expression> )]] --
* [[Core Function Match|Match( <expression> )]] --
* [[Core Function MD5|MD5( <expression> )]] --
* [[Core Function PadLeft|PadLeft( <expression> )]] --
* [[Core Function PadRight|PadRight( <expression> )]] --
* [[Core Function RandStr|RandStr( <expression> )]] --
* [[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> )]] --
* [[Core Function Reverse|Reverse( <expression> )]] --
* [[Core Function Right|Right( <expression> )]] --
* [[Core Function SHA1|SHA1( <expression> )]] --
* [[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> )]] --
* [[Core Function StrLen|StrLen( <expression> )]] --
* [[Core Function SubStr|SubStr( <expression> )]] --
* [[Core Function Trim|Trim( <expression> )]] --
* [[Core Function TrimLeft|TrimLeft( <expression> )]] --
* [[Core Function TrimRight|TrimRight( <expression> )]] --
* [[Core Function UC|UC( <expression> )]] --
* [[Core Function UCFirst|UCFirst( <expression> )]] --
* [[Core Function UCWords|UCWords( <expression> )]] --

==== 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 Delete|Delete( <array>, <expresions> )]] -- Delete items from an array that match regex patterns, number patterns, or contain specific text etc

==== Hash (Dictionary) Functions ====

==== Process Functions ====
* [[Core Function DLLCall|DLLCall( <dll>, <function>, <returntype>, <paramtypes>, <params> )]] -- Dynamically call a function in a DLL
* [[Core Function Run|Run( <file>, <workdir>, <flag> )]] -- Runs an external program
* [[Core Function RunWait|RunWait( <file>, <workdir>, <flag> )]] -- Runs an external program and waits until the program finishes
* [[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( <name>, <priority> )]] -- Changes the priority of a process
* [[Core Function ProcessWait|ProcessWait( <name>, <timeout> )]] -- Pauses the current thread until a given process exists or optional the timeout expires
* [[Core Function ProcessWaitClose|ProcessWaitClose( <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

==== Environment Management ====
* [[Core Function EnvExpand|EnvExpand( <expression> )]] -- Convert a string containing %name% env tags and return complete string with names resolved

==== 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 Functions ====
* [[Core Function Return|Return <expressions>]] -- Returns a result from a Function.
* [[Core Function Throw|Throw( <expression> )]] -- Throw an exception.
* [[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.

=== User Defined Functions ===

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

[[Category:Language Reference]]

Function Reference

2011-11-23T22:34:40Z

T3charmy: /* String 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

==== 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

==== Multithreading 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

===== 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

==== 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 BitAND|BitAND( <expression> )]] --
* [[Core Function BitNOT|BitNOT( <expression> )]] --
* [[Core Function BitOR|BitOR( <expression> )]] --
* [[Core Function BitROTATE|BitROTATE( <expression> )]] --
* [[Core Function BitSHIFT|BitSHIFT( <value>, <shift> )]] -- Performs a bit shifting operation
* [[Core Function BitXOR|BitXOR( <expression> )]] --
* [[Core Function Ceiling|Ceiling( <expression> )]] --
* [[Core Function Cos|Cos( <expression> )]] --
* [[Core Function Cosh|Cosh( <expression> )]] --
* [[Core Function Exp|Exp( <expression> )]] --
* [[Core Function Floor|Floor( <expression> )]] --
* [[Core Function Log|Log( <expression> )]] --
* [[Core Function Math|Math( <expression> )]] --
* [[Core Function Max|Max( <expression>, <expression2> )]] -- Find the greater number and return it
* [[Core Function Min|Min( <expression> )]] --
* [[Core Function Mod|Mod( <expression> )]] --
* [[Core Function Pow|Pow( <expression> )]] --
* [[Core Function Random|Random( <expression> )]] --
* [[Core Function Round|Round( <expression> )]] --
* [[Core Function Sin|Sin( <expression> )]] --
* [[Core Function Sinh|Sinh( <expression> )]] --
* [[Core Function Sqrt|Sqrt( <expression> )]] --
* [[Core Function Tan|Tan( <expression> )]] --
* [[Core Function Tanh|Tanh( <expression> )]] --
* [[Core Function Turncate|Turncate( <expression> )]] --

==== String Functions ====
* [[Core Function Asc|Asc( <expression> )]] --
* [[Core Function AscW|AscW( <expression> )]] --
* [[Core Function Chr|Chr( <expression> )]] --
* [[Core Function ChrW|ChrW( <expression> )]] --
* [[Core Function Contains|Contains( <expression> )]] --
* [[Core Function Compare|Compare( <expression> )]] --
* [[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 EndsWith|EndsWith( <expression> )]] --
* [[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> )]] --
* [[Core Function isAlphaNumeric|isAlphaNumeric( <expression> )]] --
* [[Core Function isASCII|isASCII( <expression> )]] --
* [[Core Function isEmpty|isEmpty( <expression> )]] -- Checks if a string is completely empty.
* [[Core Function isFloat|isFloat( <expression> )]] --
* [[Core Function isLower|isLower( <expression> )]] --
* [[Core Function isNumeric|isNumeric( <expression> )]] --
* [[Core Function isSpace|isSpace( <expression> )]] --
* [[Core Function isSymbol|isSpace( <expression> )]] --
* [[Core Function isUpper|isUpper( <expression> )]] --
* [[Core Function isXDigit|isXDigit( <expression> )]] --
* [[Core Function LC|LC( <expression> )]] --
* [[Core Function LCFirst|LCFirst( <expression> )]] --
* [[Core Function LCWords|LCWords( <expression> )]] --
* [[Core Function Left|Left( <expression> )]] --
* [[Core Function Match|Match( <expression> )]] --
* [[Core Function MD5|MD5( <expression> )]] --
* [[Core Function PadLeft|PadLeft( <expression> )]] --
* [[Core Function PadRight|PadRight( <expression> )]] --
* [[Core Function RandStr|RandStr( <expression> )]] --
* [[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> )]] --
* [[Core Function Reverse|Reverse( <expression> )]] --
* [[Core Function Right|Right( <expression> )]] --
* [[Core Function SHA1|SHA1( <expression> )]] --
* [[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> )]] --
* [[Core Function StrLen|StrLen( <expression> )]] --
* [[Core Function SubStr|SubStr( <expression> )]] --
* [[Core Function Trim|Trim( <expression> )]] --
* [[Core Function TrimLeft|TrimLeft( <expression> )]] --
* [[Core Function TrimRight|TrimRight( <expression> )]] --
* [[Core Function UC|UC( <expression> )]] --
* [[Core Function UCFirst|UCFirst( <expression> )]] --
* [[Core Function UCWords|UCWords( <expression> )]] --

==== 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 Delete|Delete( <array>, <expresions> )]] -- Delete items from an array that match regex patterns, number patterns, or contain specific text etc

==== Hash (Dictionary) Functions ====

==== Process Functions ====
* [[Core Function DLLCall|DLLCall( <dll>, <function>, <returntype>, <paramtypes>, <params> )]] -- Dynamically call a function in a DLL
* [[Core Function Run|Run( <file>, <workdir>, <flag> )]] -- Runs an external program
* [[Core Function RunWait|RunWait( <file>, <workdir>, <flag> )]] -- Runs an external program and waits until the program finishes
* [[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( <name>, <priority> )]] -- Changes the priority of a process
* [[Core Function ProcessWait|ProcessWait( <name>, <timeout> )]] -- Pauses the current thread until a given process exists or optional the timeout expires
* [[Core Function ProcessWaitClose|ProcessWaitClose( <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

==== Environment Management ====
* [[Core Function EnvExpand|EnvExpand( <expression> )]] -- Convert a string containing %name% env tags and return complete string with names resolved

==== 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 Functions ====
* [[Core Function Return|Return <expressions>]] -- Returns a result from a Function.
* [[Core Function Throw|Throw( <expression> )]] -- Throw an exception.
* [[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.

=== User Defined Functions ===

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

[[Category:Language Reference]]

Core Function isEmpty

2011-11-23T22:30:51Z

T3charmy: Created page with "<pre> isEmpty( <expression> ) </pre> === Description === Checks if a string is completely empty. === Parameters === ==== expression ==== The string to evaluate. === Return ..."

<pre>
isEmpty( <expression> )
</pre>

=== Description ===

Checks if a string is completely empty.

=== Parameters ===

==== expression ====

The string to evaluate.

=== Return Value ===

Success: Returns 1 if expression is empty.

Failure: Returns 0 if expression is not empty.

=== Example ===

Will return 1;
<syntaxhighlight lang="sputnik">
$result = isEmpty("");
Println("Result:" , $result);
</syntaxhighlight>

Will return 0;
<syntaxhighlight lang="sputnik">
$result = isEmpty("The fuzzy blue sweaters...");
Println("Result:" , $result);
</syntaxhighlight>

[[Category:Core Function]]

Core Function Max

2011-11-23T22:18:50Z

T3charmy: Created page with "<pre> Max( <expression>, <expression2> ) </pre> === Description === Find the greater number and return it === Parameters === ==== expression ==== Any valid numeric expressio..."

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

=== Description ===

Find the greater number and return it

=== Parameters ===

==== expression ====

Any valid numeric expression.

==== expression2 ====

Any valid numeric expression.

=== Return Value ===

Compares 2 numbers and returns the greater number.

=== Remarks ===

None.

=== Example ===

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

[[Category:Core Function]]

Function Reference

2011-11-23T22:17:37Z

T3charmy: /* Math Functions */