swarm-0.5.0.0: 2D resource gathering game with programmable robots
LicenseBSD-3-Clause
Safe HaskellSafe-Inferred
LanguageHaskell2010

Swarm.TUI.Model.Menu

Description

Sum types that represent menu options, modal dialogs, and buttons.

Synopsis

Documentation

data ScenarioOutcome Source #

Constructors

WinModal 
LoseModal 

Instances

Instances details
Show ScenarioOutcome Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> ScenarioOutcome -> ShowS #

show :: ScenarioOutcome -> String #

showList :: [ScenarioOutcome] -> ShowS #

data ModalType Source #

Constructors

HelpModal 
RecipesModal 
CommandsModal 
MessagesModal 
EntityPaletteModal 
TerrainPaletteModal 
RobotsModal 
ScenarioEndModal ScenarioOutcome 
QuitModal 
KeepPlayingModal 
DescriptionModal Entity 
GoalModal 

Instances

Instances details
Show ModalType Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> ModalType -> ShowS #

show :: ModalType -> String #

showList :: [ModalType] -> ShowS #

data ButtonAction Source #

Constructors

Cancel 
KeepPlaying 
StartOver Seed ScenarioInfoPair 
QuitAction 
Next ScenarioInfoPair 

data Modal Source #

Constructors

Modal 

Fields

modalType :: Lens' Modal ModalType Source #

modalDialog :: Lens' Modal (Dialog ButtonAction Name) Source #

data MainMenuEntry Source #

Constructors

NewGame 
Tutorial 
Achievements 
Messages 
About 
Quit 

Instances

Instances details
Bounded MainMenuEntry Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

minBound :: MainMenuEntry #

maxBound :: MainMenuEntry #

Enum MainMenuEntry Source # 
Instance details

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 Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

readsPrec :: Int -> ReadS MainMenuEntry #

readList :: ReadS [MainMenuEntry] #

readPrec :: ReadPrec MainMenuEntry #

readListPrec :: ReadPrec [MainMenuEntry] #

Show MainMenuEntry Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> MainMenuEntry -> ShowS #

show :: MainMenuEntry -> String #

showList :: [MainMenuEntry] -> ShowS #

Eq MainMenuEntry Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

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

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

Ord MainMenuEntry Source # 
Instance details

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 #

data Menu Source #

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 

mainMenu :: MainMenuEntry -> List Name MainMenuEntry Source #

_AboutMenu :: Prism' Menu () Source #

_MessagesMenu :: Prism' Menu () Source #

_AchievementsMenu :: Prism' Menu (List Name CategorizedAchievement) Source #

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

_MainMenu :: Prism' Menu (List Name MainMenuEntry) Source #

_NoMenu :: Prism' Menu () Source #

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

Create a brick List of scenario items from a ScenarioCollection.

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

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.

data InventoryListEntry Source #

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

Instances details
Eq InventoryListEntry Source # 
Instance details

Defined in Swarm.TUI.Model.Menu

Methods

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

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

_EquippedEntry :: Prism' InventoryListEntry Entity Source #

_InventoryEntry :: Prism' InventoryListEntry (Count, Entity) Source #

_Separator :: Prism' InventoryListEntry Text Source #