Documentation

Warning: The interpreter is still in beta and may have bugs. If you need help with code or find a bug, please report it on the Forum Topic.

Master List of Commands

• Set Variable: set <name> to <value> - Defines a variable.
• Set Array: array <value1> <value2> <value3> ... as <name> - Defines an array or list.
• Modify Array:
  • replace <index> of <array name> as <new value>
  • unshift <array name> <value> - Adds value to the start of an array.
  • push <array name> <value> - Adds value to the end of an array.
• Reverse Array / Text: reverse <"array" or "text"> <name> as <name> - Reverses the array or text.
• Output:
  • out <expression> - Prints the evaluated expression on a new line.
  • outl <expression> - Prints the evaluated expression in-line.
  • clear - Clears the entire output console.
• Delay: delay <seconds> - Pauses execution for a given number of seconds.
• Arithmetic Operations: Performs arithmetic and stores the result in a variable.
  • Add: add <value1> <value2> as <variable>
  • Subtract: subtract <value1> <value2> as <variable>
  • Multiply: multiply <value1> <value2> as <variable>
  • Divide: divide <value1> <value2> as <variable>
  • Modulus: modulus <value1> <value2> as <variable>
• Ask for Input: ask <prompt> as <variable> - Prompts the user for input and stores it in a variable.
• Date Functions: date <part> as <variable> - Sets the variable to the current date/time part. Parts can be `year`, `month`, `date`, `hour`, `minute`, `second`, or `timestamp`.
• Random Number: random <min> <max> as <variable> - Generates a random integer between `min` and `max` and stores it in a variable.

Comments are newlines that starting with #.

Control Structures

• While Loop: while <condition>
<commands>
end - Repeats the commands as long as the condition is true.
• If Statement: if <condition>
<commands>
end - Executes the commands if the condition is true.

Functions

• Define Function: function <name>
<commands>
end - Defines a function with the given name.
• Call Function: call <name> - Calls the function with the given name.

Conditions

Conditions use the following syntax: <value> <operator> <value>

Operators include: `=`, `!=`, `<`, and `>`. Conditions can be combined using `and`, e.g., {varname} = 1 and 12 > {myvar}.

Examples

1. Variable Assignment and Output:

       set x to 10
       out {x}

2. Arithmetic Operations:

       set a to 5
       set b to 3
       add {a} {b} as c
       out {c}

3. While Loop Example:

       set counter to 0
       while {counter} < 5
         add {counter} 1 as counter
         out {counter}
       end

4. If Statement Example:

       set num to 7
       if {num} > 5
         out "Number is greater than 5"
       end

5. Date Function Example:

       date year as currentYear
       out {currentYear}

6. Array Example:

       array a b c d as alphabet
       out The 3rd letter of the alphabet is {alphabet:3}!

7. Function Example:

       function greet
         out "Hello, World!"
       end
   
       call greet

8. Function with Conditional Logic Example:

       set x to 1
   
       function greet
         if {x} = 0
           out "Hello, World! 1"
         end
         if {x} = 1
           out "Hello, World! 2"
         end
       end
   
       call greet
       set x to 0
       call greet

Expressions

• Plain text: This is text, no need for quotes in between
• Variable usage: {variablename}
• Text with variable: Hello, {name}!
• Length of variable or array: {length:varname} {length:array}
• Letter at index: {letter 0:varname} {letter varname1:varname2}
• Array item at index: {array:0} {array:varname}