1. Built In - Functions

1.1. Base functions

Table of functions
Returns if variable is a constant variable
_{isConstant($variable: Mixed): Boolean}
Set constant
_{setConstant($constant: String, $value: Mixed): Mixed}
Returns if variable is a reference variable
_{isReference($variable: Mixed): Boolean}
Get variable type
_{getType($variable: Mixed): String}
Returns if variable exists
_{hasVariable($variable: String): Boolean}
Get variable
_{getVariable($variable: String): Mixed}
Set variable
_{setVariable($variable: String, $value: Mixed[, $operator: Integer]): Mixed}
Add
_{add($a: Mixed, $b: Mixed[, $operator: Integer]): Mixed}
Logical and
_{and($a: Boolean, $b: Boolean[, $operator: Integer]): Boolean}
Bitwise and
_{bitwiseAnd($a: Integer, $b: Integer[, $operator: Integer]): Integer}
Bitwise not
_{bitwiseNot($value: Integer[, $operator: Integer]): Integer}
Bitwise or
_{bitwiseOr($a: Integer, $b: Integer[, $operator: Integer]): Integer}
Bitwise xor
_{bitwiseXor($a: Integer, $b: Integer[, $operator: Integer]): Integer}
Create boolean
_{boolean($boolean: Boolean): Boolean}
Break out of forCondition or forTime loop
_{break([$levels: Integer]): Null}
Begins a case block within a switch block, which will be executed if the case value has matched
_{case($value: Mixed): Null}
Continue to next iteration of forCondition or forTime loop
_{continue([$levels: Integer]): Null}
Begins a default block within a switch block, which will be executed if no case value has matched
_{default(): Null}
Divide
_{div($a: Mixed, $b: Mixed[, $operator: String]): Mixed}
Else
_{else(): Null}
Else if
_{elseif($condition: Boolean): Null}
End
_{end(): Null}
Equals
_{equals($a: Mixed, $b: Mixed[, $operator: Integer]): Boolean}
For condition
_{forCondition($condition: Boolean[, $iterationStacklet: Stacklet]): Null}
For time
_{forTime($time: Integer): Null}
Greater
_{greater($a: Mixed, $b: Mixed[, $operator: Integer]): Boolean}
Greater equals
_{greaterEquals($a: Mixed, $b: Mixed[, $operator: Integer]): Boolean}
If
_{if($condition: Boolean): Null}
Create integer
_{integer($integer: Integer): Integer}
Lesser
_{lesser($a: Mixed, $b: Mixed[, $operator: Integer]): Boolean}
Lesser equals
_{lesserEquals($a: Mixed, $b: Mixed[, $operator: Integer]): Boolean}
Compute modulo
_{mod($value: Number, $range: Number[, $operator: String]): Number}
Multiply
_{mul($a: Mixed, $b: Mixed[, $operator: String]): Mixed}
Logical not
_{not($boolean: Boolean[, $operator: Integer]): Boolean}
Logical not equal
_{notEqual($a: Mixed, $b: Mixed[, $operator: Integer]): Boolean}
Logical or
_{or($a: Boolean, $b: Boolean[, $operator: Integer]): Boolean}
Postfix decrement
_{postfixDecrement(&$variable: Integer[, $operator: Integer]): Integer}
Postfix increment
_{postfixIncrement(&$variable: Integer[, $operator: Integer]): Integer}
Prefix decrement
_{prefixDecrement(&$variable: Integer[, $operator: Integer]): Integer}
Prefix increment
_{prefixIncrement(&$variable: Integer[, $operator: Integer]): Integer}
Returns from function with optional return value
_{return([$value: Mixed]): Null}
Subtract
_{sub($a: Mixed, $b: Mixed[, $operator: String]): Mixed}
Swap two variables
_{swap(&$a: Mixed, &$b: Mixed): Null}
Begins switch block to match a given value to case values or a default
_{switch($value: Mixed): Null}

1.2. Application functions

Table of functions
Get application command line arguments
_{application.getArguments(): Array}
Execute Application
_{application.execute($command: String[, &$exitCode: ?Integer[, &$error: ?String]]): String}
Exit application with optional exit code
_{application.exit([$exitCode: Integer]): Null}

1.3. Concurrency functions

Table of functions
Returns hardware thread count, which usually is the number of CPU cores(* 2, if hyperthreading is enabled)
_{concurrency.getHardwareThreadCount(): Integer}

1.4. Console functions

Table of functions
Pretty print variable to console
_{console.dump($value: Mixed): Null}
Print to console without trainling new line
_{console.print(...): Null}
Print to console with a trailing new line
_{console.printLine(...): Null}
Read all input into string value
_{console.readAll(): String}
Read all input into array of strings
_{console.readAllAsArray(): Array}
Read a line from input
_{console.readLine(): String}

1.5. Error console/stream functions

Table of functions
Print to error console/stream without trainling new line
_{console.error.print(...): Null}
Print to error console/stream with a trailing new line
_{console.error.printLine(...): Null}

1.6. Script container and interoperability functions

Table of functions
Returns if a script has a specific callable function
_{context.script.hasCallable($scriptId: String, $callable: String): Boolean}
Returns all script ids of its context
_{context.script.getScriptIds(): Array}
Call a script callable function
_{context.script.call($scriptId: String, $callable: String, ...): Mixed}
Load a script into context
_{context.script.loadScript($scriptId: String, $pathName: String, $fileName: String[, $verbose: Boolean]): Null}
Remove a script from context
_{context.script.removeScript($scriptId: String): Null}

1.1. Cryptography Base64 functions

Table of functions
Decode a Base64 encoded string
_{cryptography.base64.decode($value: String): String}
Encode a string using Base64
_{cryptography.base64.encode($value: String): String}

1.8. Cryptography SHA256 functions

Table of functions
Hash a string using SHA256
_{cryptography.sha256.encode($value: String): String}

1.9. File System functions

Table of functions
Get canonical URI
_{filesystem.getCanonicalURI($pathName: String, $fileName: String): ?String}
Get file content as byte array
_{filesystem.getContent($pathName: String, $fileName: String): ?ByteArray}
Set file content from byte array
_{filesystem.setContent($pathName: String, $fileName: String, $content: ByteArray): Boolean}
Get file content as string
_{filesystem.getContentAsString($pathName: String, $fileName: String): ?String}
Get file content as string array
_{filesystem.getContentAsStringArray($pathName: String, $fileName: String): ?Array}
Set file content from string
_{filesystem.setContentFromString($pathName: String, $fileName: String, $content: String): Boolean}
Set file content from string array
_{filesystem.setContentFromStringArray($pathName: String, $fileName: String, $content: Array): Boolean}
Get current working path name
_{filesystem.getCurrentWorkingPathName(): ?String}
Returns if given URI is a drive name(applies to Microsoft Windows only)
_{filesystem.isDrive($uri: String): Boolean}
Extracts file name from given URI
_{filesystem.getFileName($uri: String): String}
Returns file size from file
_{filesystem.getFileSize($pathName: String, $fileName: String): ?Integer}
Returns if given URI is a path
_{filesystem.isPath($uri: String): ?Boolean}
Extracts path name from given URI
_{filesystem.getPathName($uri: String): String}
Change current working path
_{filesystem.changePath($pathName: String): Boolean}
Compose URI from given path name and file name
_{filesystem.composeURI($pathName: String, $fileName: String): String}
Create path
_{filesystem.createPath($pathName: String): Boolean}
Returns if URI does exist
_{filesystem.exists($uri: String): ?Boolean}
List folder
_{filesystem.list($pathName: String): ?Array}
Move file/folder from a location to another location
_{filesystem.move($uriFrom: String, $uriTo: String): Boolean}
Removes a file with given file name
_{filesystem.removeFile($pathName: String, $fileName: String): Boolean}
Removes a file extension from given file name
_{filesystem.removeFileExtension($fileName: String): String}
Removes a path from file system
_{filesystem.removePath($pathName: String, $recursive: String): Boolean}
Renames a file/folder
_{filesystem.rename($fileNameFrom: String, $fileNameTo: String): Boolean}

1.10. Float functions

Table of functions
Create float
_{float($float: Float): Float}
Convert integer bit representation of float to float
_{float.fromIntegerValue($integer: Integer): Float}
Convert float to integer bit representation of float
_{float.toIntegerValue($float: Float): Integer}

1.11. Hex functions

Table of functions
Decode hexadecimal string to integer value
_{hex.decode($value: String): Integer}
Encode integer value to hexadecimal string
_{hex.encode($value: Integer): String}

1.12. JSON functions

Table of functions
Deserialize JSON
_{json.deserialize($json: String): Mixed}
Serialize JSON
_{json.serialize($value: Mixed): String}

1.13. Math functions

Table of functions
Returns number as positive number
_{math.abs($value: Number): Number}
Returns number to be positive within given range
_{math.absmod($value: Number, $range: Number): Number}
Compute acos
_{math.acos($x: Float): Float}
Compute asin
_{math.asin($x: Float): Float}
Compute atan
_{math.atan($x: Float): Float}
Compute atan2
_{math.atan2($y: Float, $x: Float): Float}
Round float up to next higher integer
_{math.ceil($value: Float): Float}
Returns number clamped to be in given range
_{math.clamp($value: Number, $min: Number, $max: Number): Number}
Compute acos
_{math.cos($x: Float): Float}
Compute exp
_{math.exp($power: Float): Float}
Round float down to next lower integer
_{math.floor($value: Float): Float}
Compute log
_{math.log($value: Float): Float}
Returns maximum number of given values
_{math.max($value1: Number, $value2: Number): Number}
Returns minimum number of given values
_{math.min($value1: Number, $value2: Number): Number}
Compute modulo/remainder
_{math.mod($value: Number, $range: Number): Number}
Compute pow
_{math.pow($base: Number, $power: Number): Number}
Create a random number between 0.0 and 1.0
_{math.random(): Float}
Round float up or down to integer
_{math.round($value: Float): Float}
Returns sign of given number
_{math.sign($value: Number): Number}
Compute sin
_{math.sin($x: Float): Float}
Compute square root
_{math.sqrt($value: Float): Float}
Compute square product
_{math.square($value: Number): Number}
Compute tan
_{math.tan($x: Float): Float}

1.14. HTTP/HTTPS client functions

Table of functions
Execute a HTTP/HTTPS GET request
_{network.httpclient.get($url: String[, $queryParameters: ?Map[, $headers: ?Map]]): ?Map}
Execute a HTTP/HTTPS DELETE request
_{network.httpclient.delete($url: String[, $queryParameters: ?Map[, $headers: ?Map]]): ?Map}
Execute a HTTP/HTTPS HEAD request
_{network.httpclient.head($url: String[, $queryParameters: ?Map[, $headers: ?Map]]): ?Map}
Execute a HTTP/HTTPS POST request
_{network.httpclient.post($url: String, $data: Mixed[, $queryParameters: ?Map[, $headers: ?Map]]): ?Map}
Execute a HTTP/HTTPS PUT request
_{network.httpclient.put($url: String, $data: Mixed[, $queryParameters: ?Map[, $headers: ?Map]]): ?Map}

1.15. Script functions

Table of functions
Get named conditions
_{script.getNamedConditions(): String}
Returns if script runs natively
_{script.isNative(): Boolean}
Get script variables
_{script.getVariables(): Map}
Call script function
_{script.call($function: String, ...): Mixed}
Call function by function variable
_{script.callFunction($function: Function, ...): Mixed}
Call script stacklet
_{script.callStacklet($stacklet: String): Mixed}
Disable a specific named condition
_{script.disableNamedCondition($name: String): Null}
Emit a condition
_{script.emit($condition: String): Null}
Enable a specific named condition
_{script.enableNamedCondition($name: String): Null}
Evaluate a script statement
_{script.evaluate($statement: String): Mixed}
Stop script
_{script.stop(): Null}
Wait for given milliseconds
_{script.wait($time: Integer): Null}
Wait for condition to happen
_{script.waitForCondition(): Null}

1.16. Script error functions

Table of functions
Get last error message if any occurred
_{script.error.getMessage(): ?String}
Get last error statement if any exists
_{script.error.getStatement(): ?Map}

1.11. Time functions

Table of functions
Get time as string
_{time.getAsString([$format: String]): String}
Get current time in milliseconds
_{time.getCurrentMillis(): Integer}

1.18. XML functions

Table of functions
Create XML tag
_{xml.createTag($name: String[, $attributes: Map[, $innerXML: String]]): String}

2. Links

2.1. Language Documentation

2.2. Other Links

MinitScript, see README.md
MinitScript - How to build, see README-BuildingHowTo.md
MinitScript - How to use, see README-Tools.md
MinitScript - ToDo list, see README-ToDo.md
The Mindty Kollektiv Discord Server