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. The custom event PopupEvent is sent by the animation manager and contains an event that starts, stops, or updates a popup notification.

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.

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.

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

Simply log to the runtime event log.

Keybindings (possibly customized by player) for SwarmEvents.

Dispatchers that will call handler on key combo.

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 UIState record.

The ScenarioState record.

The key event handling configuration.

The RuntimeState record

The AnimationManager record

This encapsulates both game and UI state for an actively-playing scenario, as well as state that evolves as a result of playing a scenario.

The GameState record.

UI active during live gameplay

This encapsulates both game and UI state for an actively-playing scenario, as well as state that evolves as a result of playing a scenario.

The ScenarioState record.

State that can evolve as the user progresses through scenarios.

State that can evolve as the user progresses through scenarios. This includes achievements and completion records.

Note that scenario completion/achievements are serialized to disk storage, but we also persist in memory since we don't reload data from disk as we progress through scenarios.

The collection of scenarios that comes with the game.

Map of achievements that were attained

Queue of popups to display

Popup Animation State

Remaining scenarios in the current sequence

This enapsulates the state of a given animation that changes over time. AnimInactive means that the application is ready to start a new animation. AnimScheduled means that the application has told the animation manager to start the animation, but it hasn't started yet. AnimActive means that the animation is currently in progress.

Prisms for AnimationState

Command-line options for configuring the app.

A default/empty AppOpts record.

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.

A non-lawful traversal for use in animations that allows us to manage the state of an animation and update it properly when we process an event sent by the animation manager. Exploits some assumptions about Brick's implementation of animations. It is defined such that when the animation manager starts the animation by setting the target of the traversal to Just theAnimation, the traversal will actually set the AnimationState of the popup animation to AnimActive theAnimation. When the animation manager signals that the animation has stopped by setting the target of the traversal to Nothing, the traversal will set the AnimationState of the popup to AnimInactive.