Documentation

Record to pass information needed to create an initial GameState record when starting a scenario.

A data type to represent the current status of the REPL.

A record to keep track of the completion status of all a scenario's objectives. We do not export the constructor or record field labels of this type in order to ensure that its internal invariants cannot be violated.

TODO: #1044 Could also add an ObjectiveFailed constructor...

A data type to keep track of the pause mode.

Game step mode - we use the single step mode when debugging robot CESK machine.

Type for remembering which robots will be run next in a robot step mode.

Once some robots have run, we need to store RID to know which ones should go next. At SBefore no robots were run yet, so it is safe to transition to and from WorldTick.

                    tick
    ┌────────────────────────────────────┐
    │                                    │
    │               step                 │
    │              ┌────┐                │
    ▼              ▼    │                │
┌───────┐ step  ┌───────┴───┐ step  ┌────┴─────┐
│SBefore├──────►│SSingle RID├──────►│SAfter RID│
└──┬────┘       └───────────┘       └────┬─────┘
   │ ▲ player        ▲                   │
   ▼ │ switch        └───────────────────┘
┌────┴────┐             view RID > oldRID
│WorldTick│
└─────────┘

The initial seed that was used for the random number generator, and world generation.

Pseudorandom generator initialized at start.

How to step the game: WorldTick or RobotStep for debugging the CESK machine.

The current RunStatus.

The number of ticks elapsed since the game started.

The maximum number of CESK machine steps a robot may take during a single tick.

Whether the game is currently paused.

Whether to pause the game after an objective is completed.

All recipes the game knows about, indexed by outputs.

All recipes the game knows about, indexed by inputs.

All recipes the game knows about, indexed by requirement/catalyst.

A queue of global messages.

Note that we put the newest entry to the right.

Last time message queue has been viewed (used for notification).

A queue of global announcements. Note that this is distinct from the messageQueue, which is for messages emitted by robots.

Note that we put the newest entry to the right.

Code that is run upon scenario start, before any REPL interaction.

The current status of the REPL.

The index of the next it{index} value

The action to be run after transitioning to REPLDone. This is used to tell Web API the result of run command.

The currently installed input handler and hint text.

The list of entities that have been discovered.

The list of available recipes.

The list of available commands.

The names of entities that should be considered "known", that is, robots know what they are without having to scan them.

The set of all entities that can be crafted in the current scenario.

Map of in-game achievements that were obtained

Recognizer for robot-constructed structures

Map from tags to entities that possess that tag

A data type to keep track of some kind of log or sequence, with an index to remember which ones are "new", which ones have "already been seen", and whether the user has yet been notified of the fact that there are unseen notifications.

By default, robots may make a maximum of 100 CESK machine steps during one game tick.

Either the type of the command being executed, or of the last command

Whether the repl is currently working.

Switch (auto or manually) paused game to running and running to manually paused.

Note that this function is not safe to use in the app directly, because the UI also tracks time between ticks---use safeTogglePause instead.