UserInterface

Table of Contents

• Overview
• Toolbar
  • File
  • Settings
• Output
• Snippet Editor
  • Toolbar
  • Title
  • Text Editor
  • Status Bar

Overview

This page will go over each of the elements that make up the user interface.

Toolbar

This overlay contains icons that the developer can interact with to perform various functions in the application.

File

The File icon allows developers to create, open, or close workspaces, along with exiting the application.

Settings

The Settings icon provides the 'About' dialog.

Output

This window will display any output from the application or the executing snippets.

Snippet Editor

This window is displayed when the developer edits a snippet.

Title

The title bar for the window consists of the following elements:

• Title - The name of the snippet is displayed in the center. This label can be double-clicked to edit the name of the snippet.
• Close Button - Clicking this will close the window.

The window can be moved by clicking on any part of this area and dragging the mouse.

Snippet Toolbar

The toolbar consists of buttons that allow the developer to perform operations related to snippets. The buttons are described in order below:

1. Run - Runs all connected snippets starting from the 'main' snippet.
2. Run Unit Test - Runs the snippet associated with this window. How the unit test behaves will be covered in later updates.
   • The behavior of this button changes during an active debug session. The button will be re-enabled if the program hits a breakpoint. The behavior is then to step to the next line of execution and pause again, going through the program line by line.
3. Resume - Resumes a paused debug session. This button is disabled until the running program hits a breakpoint.
4. Stop - Stops execution of the current snippet. This also stops running all snippets if 'Run' was clicked.

Text Editor

The text editor consists of tabs to indicate which part of the snippet is being edited. The tabs in order are:

1. Snippet - The main snippet of Lua code that is executed. When the text is changed, the editor will attempt to compile the changed code. If there are any errors, it is reported in the status bar.
2. Unit Test - The unit test associated with this snippet. This is currently experimental and more details will come in later versions.
3. Lua - Experimental. Idea is that if any custom syntax was added to the snippet text, this will show the Lua generated code based of the new syntax. Essentially Lua++.

The tabs are then followed by the main text editor. This is similar to what you will find in many other applications that allows for text modification, although a bit more limited.

Autocomplete

This small window is a popup that is displayed when text is entered to provide suggestions on what the desired text may be. This list can be navigated by the mouse or keyboard, and can be selected with a click or the tab key.

Breakpoints

The region to the left of line numbers can be clicked on per line. Doing so will place a breakpoint at that line. This will notify the running program to pause execution on that line and will not continue until requested to 'Step' or 'Resume'.

Variable Inspection

If the running program is paused due to a breakpoint, variables declared before the breakpoint can then be inspected for what value they hold. This is currently done by hovering the mouse over the variable name and a popup will appear with the value. Currently, only basic data types are supported.

Status Bar

The status bar shows the result of any compiling or execution of snippets.