AppEvent represents a type for custom event types our app can receive. The primary custom event Frame is sent by a separate thread as fast as it can, telling the TUI to render a new frame.

Name represents names to uniquely identify various components of the UI, such as forms, panels, caches, extents, lists, and buttons.

Clickable buttons in modal dialogs.

Create a brick List of scenario items from a ScenarioCollection.

Given a ScenarioCollection and a FilePath which is the canonical path to some folder or scenario, construct a NewGameMenu stack focused on the given item, if possible.

An item in the REPL history.

Get the text of REPL input/output.

Useful helper function to filter out REPL output.

Useful helper function to only get user input text.

History of the REPL with indices (0 is first entry) to the current line and to the first entry since loading saved history. We also (ab)use the length of the REPL as the index of current input line, since that number is one past the index of last entry.

The current index in the REPL history (if the user is going back through the history using up/down keys).

Current number lines of the REPL history - (ab)used as index of input buffer.

Sequence of REPL inputs and outputs, oldest entry is leftmost.

Create new REPL history (i.e. from loaded history file lines).

Add new REPL input - the index must have been pointing one past the last element already, so we increment it to keep it that way.

Point the start of REPL history after current last line. See replStart.

Get the latest N items in history, starting with the oldest one.

This is used to show previous REPL lines in UI, so we need the items sorted in the order they were entered and will be drawn top to bottom.

This data type tells us how to interpret the text typed by the player at the prompt (which is stored in Editor).

Given some text, removes the REPLEntry within REPLHistory which is equal to that. This is used when the user enters in search mode and want to traverse the history. If a command has been used many times, the history will be populated with it causing the effect that search command always finds the same command.

An entry in the inventory list displayed in the info panel. We can either have an entity with a count in the robot's inventory, an entity equipped on the robot, or a labelled separator. The purpose of the separators is to show a clear distinction between the robot's inventory and its equipped devices.

What is being done with user input to the REPL panel?

The way we interpret text typed by the player in the REPL prompt.

The prompt where the user can type input at the REPL.

Convenience lens to get text from editor and replace it with new one that has the provided text.

Whether the prompt text is a valid Term.

The last thing the user has typed which isn't part of the history. This is used to restore the repl form after the user visited the history.

The type of the current REPL input which should be displayed to the user (if any).

The current REPL control mode, i.e. how user input to the REPL panel is being handled.

History of things the user has typed at the REPL, interleaved with outputs the system has generated.

Given the focused robot, populate the UI inventory list in the info panel with information about its inventory.

The port on which the HTTP debug service is running.

The upstream release version.

A log of runtime events.

This logging is separate from the logging done during game-play. If some error happens before a game is even selected, this is the place to log it.

A collection of typechecked world DSL terms that are available to be used in scenario definitions.

The collection of scenarios that comes with the game.

The standard entity map loaded from disk. Individual scenarios may define additional entities which will get added to this map when loading the scenario.

The standard list of recipes loaded from disk. Individual scenarios may define additional recipes which will get added to this list when loading the scenario.

Free-form data loaded from the data directory, for things like the logo, about page, tutorial story, etc.

Lists of words/adjectives for use in building random robot names.

Simply log to the runtime event log.

Create a GameStateConfig record from the RuntimeState.

The AppState just stores together the other states.

This is so you can use a smaller state when e.g. writing some game logic or updating the UI. Also consider that GameState can change when loading a new scenario - if the state should persist games, use RuntimeState.

The GameState record.

The UIState record.

The RuntimeState record

Command-line options for configuring the app.

A default/empty AppOpts record.

Context for the REPL commands to execute in. Contains the base robot context plus the it variable that refer to the previously computed values. (Note that `it{n}` variables are set in the base robot context; we only set it here because it's so transient)

Get the currently focused InventoryListEntry from the robot info panel (if any).

Get the currently focused entity from the robot info panel (if any). This is just like focusedItem but forgets the distinction between plain inventory items and equipped devices.

Extract the scenario which would come next in the menu from the currently selected scenario (if any). Can return Nothing if either we are not in the NewGameMenu, or the current scenario is the last among its siblings.