Documentation

The main record holding the UI state. For access to the fields, see the lenses below.

The current menu state.

Are we currently playing the game?

• True = we are playing, and should thus display a world, REPL, etc.
• False = we should display the current menu.

Cheat mode, i.e. are we allowed to turn creative mode on and off?

The focus ring is the set of UI panels we can cycle among using the Tab key.

Configuration modal when launching a scenario

The last clicked position on the world view.

State of all World Editor widgets

The state of REPL panel.

The hash value of the focused robot entity (so we can tell if its inventory changed) along with a list of the items in the focused robot's inventory.

The order and direction of sorting inventory list.

The current search string used to narrow the inventory view.

A flag telling the UI to scroll the info panel to the very end (used when a new log message is appended).

When this is Just, it represents a modal to be displayed on top of the UI, e.g. for the Help screen.

Status of the scenario goal: whether there is one, and whether it has been displayed to the user initially.

When running with --autoplay, suppress the goal dialogs.

For development, the --cheat flag shows goals again.

Map of achievements that were attained

The base-2 logarithm of the current game speed in ticks/second. Note that we cap this value to the range of +/- log2 INTMAX.

The time of the last Frame event.

The amount of accumulated real time. Every time we get a Frame event, we accumulate the amount of real time that happened since the last frame, then attempt to take an appropriate number of ticks to "catch up", based on the target tick rate.

See https://gafferongames.com/post/fix_your_timestep/ .

A counter used to track how many ticks have happened since the last time we updated the ticks/frame statistics.

A counter used to track how many frames have been rendered since the last time we updated the ticks/frame statistics.

A counter used to track how many ticks have happened in the current frame, so we can stop when we get to the tick cap.

The time of the last info widget update

A toggle to show the FPS by pressing f

A toggle to expand or collapse the REPL by pressing Ctrl-k

A toggle to show or hide inventory items with count 0 by pressing 0

A toggle to show debug.

TODO: #1112 use record for selection of debug features?

Whether to show or hide robots on the world map.

Hide robots on the world map.

Whether the Inventory ui panel should update

Computed ticks per milliseconds

Computed frames per milliseconds

Attribute map

The currently active Scenario description, useful for starting over.

The initial state of the focus ring. NOTE: Normally, the Tab key might cycle through the members of the focus ring. However, the REPL already uses Tab. So, to is not used at all right now for navigating the toplevel focus ring.

The initial tick speed.

Initialize the UI state. This needs to be in the IO monad since it involves reading a REPL history file, getting the current time, and loading text files from the data directory. The Bool parameter indicates whether we should start off by showing the main menu.