Swarm.TUI.Model

Application state for the brick-based Swarm TUI.

Custom UI label types

These types are used as parameters to various brick types.

data AppEvent

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.

Constructors

Frame

Web WebCommand

UpstreamVersion (Either NewReleaseFailure String)

Instances

Show AppEvent

Defined in Swarm.TUI.Model

Methods

showsPrec :: Int -> AppEvent -> ShowS

show :: AppEvent -> String

showList :: [AppEvent] -> ShowS

newtype WebCommand

Constructors

RunWebCode Text

Instances

Show WebCommand

Defined in Swarm.TUI.Model

Methods

showsPrec :: Int -> WebCommand -> ShowS

show :: WebCommand -> String

showList :: [WebCommand] -> ShowS

data FocusablePanel

Constructors

REPLPanel

The panel containing the REPL.

WorldPanel

The panel containing the world view.

WorldEditorPanel

The panel containing the world editor controls.

RobotPanel

The panel showing robot info and inventory on the top left.

InfoPanel

The info panel on the bottom left.

Instances

Bounded FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

minBound :: FocusablePanel

maxBound :: FocusablePanel

Enum FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

succ :: FocusablePanel -> FocusablePanel

pred :: FocusablePanel -> FocusablePanel

toEnum :: Int -> FocusablePanel

fromEnum :: FocusablePanel -> Int

enumFrom :: FocusablePanel -> [FocusablePanel]

enumFromThen :: FocusablePanel -> FocusablePanel -> [FocusablePanel]

enumFromTo :: FocusablePanel -> FocusablePanel -> [FocusablePanel]

enumFromThenTo :: FocusablePanel -> FocusablePanel -> FocusablePanel -> [FocusablePanel]

Read FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

readsPrec :: Int -> ReadS FocusablePanel

readList :: ReadS [FocusablePanel]

readPrec :: ReadPrec FocusablePanel

readListPrec :: ReadPrec [FocusablePanel]

Show FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

showsPrec :: Int -> FocusablePanel -> ShowS

show :: FocusablePanel -> String

showList :: [FocusablePanel] -> ShowS

Eq FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

(==) :: FocusablePanel -> FocusablePanel -> Bool

(/=) :: FocusablePanel -> FocusablePanel -> Bool

Ord FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

compare :: FocusablePanel -> FocusablePanel -> Ordering

(<) :: FocusablePanel -> FocusablePanel -> Bool

(<=) :: FocusablePanel -> FocusablePanel -> Bool

(>) :: FocusablePanel -> FocusablePanel -> Bool

(>=) :: FocusablePanel -> FocusablePanel -> Bool

max :: FocusablePanel -> FocusablePanel -> FocusablePanel

min :: FocusablePanel -> FocusablePanel -> FocusablePanel

data Name

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

Constructors

FocusablePanel FocusablePanel

WorldEditorPanelControl WorldEditorFocusable

An individual control within the world editor panel.

REPLInput

The REPL input form.

REPLHistoryCache

The REPL history cache.

WorldCache

The render cache for the world view.

WorldExtent

The cached extent for the world view.

WorldPositionIndicator

The cursor/viewCenter display in the bottom left of the World view

EntityPaintList

The list of possible entities to paint a map with.

EntityPaintListItem Int

The entity paint item position in the EntityPaintList.

TerrainList

The list of possible terrain materials.

TerrainListItem Int

The terrain item position in the TerrainList.

InventoryList

The list of inventory items for the currently focused robot.

InventoryListItem Int

The inventory item position in the InventoryList.

MenuList

The list of main menu choices.

AchievementList

The list of achievements.

ScenarioConfigControl ScenarioConfigPanel

An individual control within the scenario launch config panel

GoalWidgets GoalWidget

The list of goals/objectives.

StructureWidgets StructureWidget

The list of goals/objectives.

ScenarioList

The list of scenario choices.

InfoViewport

The scrollable viewport for the info panel.

ModalViewport

The scrollable viewport for any modal dialog.

REPLViewport

The scrollable viewport for the REPL.

Button Button

A clickable button in a modal dialog.

CustomName Text

A custom widget name, for use in applications built on top of the Swarm library.

Instances

Read Name

Defined in Swarm.TUI.Model.Name

Methods

readsPrec :: Int -> ReadS Name

readList :: ReadS [Name]

readPrec :: ReadPrec Name

readListPrec :: ReadPrec [Name]

Show Name

Defined in Swarm.TUI.Model.Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Eq Name

Defined in Swarm.TUI.Model.Name

Methods

(==) :: Name -> Name -> Bool

(/=) :: Name -> Name -> Bool

Ord Name

Defined in Swarm.TUI.Model.Name

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

(<=) :: Name -> Name -> Bool

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Menus and dialogs

data ModalType

Constructors

HelpModal

RecipesModal

CommandsModal

MessagesModal

StructuresModal

EntityPaletteModal

TerrainPaletteModal

RobotsModal

ScenarioEndModal ScenarioOutcome

QuitModal

KeepPlayingModal

DescriptionModal Entity

GoalModal

Instances

Show ModalType

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> ModalType -> ShowS

show :: ModalType -> String

showList :: [ModalType] -> ShowS

Eq ModalType

Defined in Swarm.TUI.Model.Menu

Methods

(==) :: ModalType -> ModalType -> Bool

(/=) :: ModalType -> ModalType -> Bool

data ScenarioOutcome

Constructors

WinModal

LoseModal

Instances

Show ScenarioOutcome

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> ScenarioOutcome -> ShowS

show :: ScenarioOutcome -> String

showList :: [ScenarioOutcome] -> ShowS

Eq ScenarioOutcome

Defined in Swarm.TUI.Model.Menu

Methods

(==) :: ScenarioOutcome -> ScenarioOutcome -> Bool

(/=) :: ScenarioOutcome -> ScenarioOutcome -> Bool

data Button

Clickable buttons in modal dialogs.

Constructors

CancelButton

KeepPlayingButton

StartOverButton

QuitButton

NextButton

Instances

Bounded Button

Defined in Swarm.TUI.Model.Name

Methods

minBound :: Button

maxBound :: Button

Enum Button

Defined in Swarm.TUI.Model.Name

Methods

succ :: Button -> Button

pred :: Button -> Button

toEnum :: Int -> Button

fromEnum :: Button -> Int

enumFrom :: Button -> [Button]

enumFromThen :: Button -> Button -> [Button]

enumFromTo :: Button -> Button -> [Button]

enumFromThenTo :: Button -> Button -> Button -> [Button]

Read Button

Defined in Swarm.TUI.Model.Name

Methods

readsPrec :: Int -> ReadS Button

readList :: ReadS [Button]

readPrec :: ReadPrec Button

readListPrec :: ReadPrec [Button]

Show Button

Defined in Swarm.TUI.Model.Name

Methods

showsPrec :: Int -> Button -> ShowS

show :: Button -> String

showList :: [Button] -> ShowS

Eq Button

Defined in Swarm.TUI.Model.Name

Methods

(==) :: Button -> Button -> Bool

(/=) :: Button -> Button -> Bool

Ord Button

Defined in Swarm.TUI.Model.Name

Methods

compare :: Button -> Button -> Ordering

(<) :: Button -> Button -> Bool

(<=) :: Button -> Button -> Bool

(>) :: Button -> Button -> Bool

(>=) :: Button -> Button -> Bool

max :: Button -> Button -> Button

min :: Button -> Button -> Button

data ButtonAction

Constructors

Cancel

KeepPlaying

StartOver Seed ScenarioInfoPair

QuitAction

Next ScenarioInfoPair

data Modal

Constructors

Modal

Fields

• _modalType :: ModalType
• _modalDialog :: Dialog ButtonAction Name

modalType :: Lens' Modal ModalType

modalDialog :: Lens' Modal (Dialog ButtonAction Name)

data MainMenuEntry

Constructors

NewGame

Tutorial

Achievements

Messages

About

Quit

Instances

Bounded MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

minBound :: MainMenuEntry

maxBound :: MainMenuEntry

Enum MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

succ :: MainMenuEntry -> MainMenuEntry

pred :: MainMenuEntry -> MainMenuEntry

toEnum :: Int -> MainMenuEntry

fromEnum :: MainMenuEntry -> Int

enumFrom :: MainMenuEntry -> [MainMenuEntry]

enumFromThen :: MainMenuEntry -> MainMenuEntry -> [MainMenuEntry]

enumFromTo :: MainMenuEntry -> MainMenuEntry -> [MainMenuEntry]

enumFromThenTo :: MainMenuEntry -> MainMenuEntry -> MainMenuEntry -> [MainMenuEntry]

Read MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

readsPrec :: Int -> ReadS MainMenuEntry

readList :: ReadS [MainMenuEntry]

readPrec :: ReadPrec MainMenuEntry

readListPrec :: ReadPrec [MainMenuEntry]

Show MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> MainMenuEntry -> ShowS

show :: MainMenuEntry -> String

showList :: [MainMenuEntry] -> ShowS

Eq MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

(==) :: MainMenuEntry -> MainMenuEntry -> Bool

(/=) :: MainMenuEntry -> MainMenuEntry -> Bool

Ord MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

compare :: MainMenuEntry -> MainMenuEntry -> Ordering

(<) :: MainMenuEntry -> MainMenuEntry -> Bool

(<=) :: MainMenuEntry -> MainMenuEntry -> Bool

(>) :: MainMenuEntry -> MainMenuEntry -> Bool

(>=) :: MainMenuEntry -> MainMenuEntry -> Bool

max :: MainMenuEntry -> MainMenuEntry -> MainMenuEntry

min :: MainMenuEntry -> MainMenuEntry -> MainMenuEntry

mainMenu :: MainMenuEntry -> List Name MainMenuEntry

data Menu

Constructors

NoMenu

We started playing directly from command line, no menu to show

MainMenu (List Name MainMenuEntry)

NewGameMenu (NonEmpty (List Name ScenarioItem))

Stack of scenario item lists. INVARIANT: the currently selected menu item is ALWAYS the same as the scenario currently being played. See https://github.com/swarm-game/swarm/issues/1064 and https://github.com/swarm-game/swarm/pull/1065.

AchievementsMenu (List Name CategorizedAchievement)

MessagesMenu

AboutMenu

_NewGameMenu :: Prism' Menu (NonEmpty (List Name ScenarioItem))

mkScenarioList :: Bool -> ScenarioCollection -> List Name ScenarioItem

Create a brick List of scenario items from a ScenarioCollection.

mkNewGameMenu :: Bool -> ScenarioCollection -> FilePath -> Maybe Menu

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.

UI state

Inventory

data InventoryListEntry

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.

Constructors

Separator Text

InventoryEntry Count Entity

EquippedEntry Entity

Instances

Eq InventoryListEntry

Defined in Swarm.TUI.Model.Menu

Methods

(==) :: InventoryListEntry -> InventoryListEntry -> Bool

(/=) :: InventoryListEntry -> InventoryListEntry -> Bool

_Separator :: Prism' InventoryListEntry Text

_InventoryEntry :: Prism' InventoryListEntry (Count, Entity)

_EquippedEntry :: Prism' InventoryListEntry Entity

Updating

populateInventoryList :: MonadState UIInventory m => Maybe Robot -> m ()

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

infoScroll :: ViewportScroll Name

modalScroll :: ViewportScroll Name

replScroll :: ViewportScroll Name

Utility

logEvent :: LogSource -> Severity -> Text -> Text -> Notifications LogEntry -> Notifications LogEntry

Simply log to the runtime event log.

type SwarmKeyDispatcher = KeyDispatcher SwarmEvent (EventM Name AppState)

data KeyEventHandlingState

Constructors

KeyEventHandlingState (KeyConfig SwarmEvent) SwarmKeyDispatchers

data SwarmKeyDispatchers

Constructors

SwarmKeyDispatchers

Fields

• mainGameDispatcher :: SwarmKeyDispatcher
• replDispatcher :: SwarmKeyDispatcher
• worldDispatcher :: SwarmKeyDispatcher
• robotDispatcher :: SwarmKeyDispatcher

keyConfig :: Lens' KeyEventHandlingState (KeyConfig SwarmEvent)

Keybindings (possibly customized by player) for SwarmEvents.

keyDispatchers :: Lens' KeyEventHandlingState SwarmKeyDispatchers

Dispatchers that will call handler on key combo.

App state

data AppState

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.

Constructors

AppState GameState UIState KeyEventHandlingState RuntimeState

gameState :: Lens' AppState GameState

The GameState record.

uiState :: Lens' AppState UIState

The UIState record.

keyEventHandling :: Lens' AppState KeyEventHandlingState

The key event handling configuration.

runtimeState :: Lens' AppState RuntimeState

The RuntimeState record

Initialization

data AppOpts

Command-line options for configuring the app.

Constructors

AppOpts

Fields

• userSeed :: Maybe Seed

  Explicit seed chosen by the user.

• userScenario :: Maybe FilePath

  Scenario the user wants to play.

• scriptToRun :: Maybe FilePath

  Code to be run on base.

• autoPlay :: Bool

  Automatically run the solution defined in the scenario file

• speed :: Int

  Initial game speed (logarithm)

• cheatMode :: Bool

  Should cheat mode be enabled?

• colorMode :: Maybe ColorMode

  What colour mode should be used?

• userWebPort :: Maybe Port

  Explicit port on which to run the web API

• repoGitInfo :: Maybe GitInfo

  Information about the Git repository (not present in release).

defaultAppOpts :: AppOpts

A default/empty AppOpts record.

Re-exported types used in options

data ColorMode

Constructors

NoColor

ColorMode8

ColorMode16

ColorMode240 !Word8

FullColor

Instances

Read ColorMode

Defined in Graphics.Vty.Attributes.Color

Methods

readsPrec :: Int -> ReadS ColorMode

readList :: ReadS [ColorMode]

readPrec :: ReadPrec ColorMode

readListPrec :: ReadPrec [ColorMode]

Show ColorMode

Defined in Graphics.Vty.Attributes.Color

Methods

showsPrec :: Int -> ColorMode -> ShowS

show :: ColorMode -> String

showList :: [ColorMode] -> ShowS

Eq ColorMode

Defined in Graphics.Vty.Attributes.Color

Methods

(==) :: ColorMode -> ColorMode -> Bool

(/=) :: ColorMode -> ColorMode -> Bool

Utility

focusedItem :: AppState -> Maybe InventoryListEntry

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

focusedEntity :: AppState -> Maybe Entity

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.

nextScenario :: Menu -> Maybe ScenarioInfoPair

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.