License	BSD-3-Clause
Safe Haskell	None
Language	Haskell2010

Swarm.TUI.Model.Menu

Description

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

Synopsis

data ScenarioOutcome
- = WinModal
- | LoseModal
data MidScenarioModalType
- = HelpModal
- | RecipesModal
- | CommandsModal
- | MessagesModal
- | StructuresModal
- | EntityPaletteModal
- | TerrainPaletteModal
- | RobotsModal
- | DescriptionModal Entity
- | GoalModal
data EndScenarioModalType
- = ScenarioFinishModal ScenarioOutcome
- | QuitModal
- | KeepPlayingModal
data ModalType
- = MidScenarioModal MidScenarioModalType
- | EndScenarioModal EndScenarioModalType
data ButtonAction
- = Cancel
- | KeepPlaying
- | StartOver Seed (ScenarioWith ScenarioPath)
- | QuitAction
- | Next (NonEmpty (ScenarioWith ScenarioPath))
data Modal = Modal {
- _modalType :: ModalType
- _modalDialog :: Dialog ButtonAction Name
}
modalDialog :: Lens' Modal (Dialog ButtonAction Name)
modalType :: Lens' Modal ModalType
data MainMenuEntry
- = NewGame
- | Tutorial
- | Achievements
- | Messages
- | About
- | Quit
data Menu
- = NoMenu
- | MainMenu (List Name MainMenuEntry)
- | NewGameMenu (NonEmpty (List Name (ScenarioItem ScenarioPath)))
- | AchievementsMenu (List Name CategorizedAchievement)
- | MessagesMenu
- | AboutMenu
mainMenu :: MainMenuEntry -> List Name MainMenuEntry
_NoMenu :: Prism' Menu ()
_MainMenu :: Prism' Menu (List Name MainMenuEntry)
_NewGameMenu :: Prism' Menu (NonEmpty (List Name (ScenarioItem ScenarioPath)))
_AchievementsMenu :: Prism' Menu (List Name CategorizedAchievement)
_MessagesMenu :: Prism' Menu ()
_AboutMenu :: Prism' Menu ()
mkScenarioList :: ScenarioCollection a -> List Name (ScenarioItem a)
data InventoryListEntry
- = Separator Text
- | InventoryEntry Count Entity
- | EquippedEntry Entity
_Separator :: Prism' InventoryListEntry Text
_InventoryEntry :: Prism' InventoryListEntry (Count, Entity)
_EquippedEntry :: Prism' InventoryListEntry Entity

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 #
Eq ScenarioOutcome Source #
Instance details Defined in Swarm.TUI.Model.Menu Methods (==) :: ScenarioOutcome -> ScenarioOutcome -> Bool # (/=) :: ScenarioOutcome -> ScenarioOutcome -> Bool #

data MidScenarioModalType Source #

Constructors

HelpModal
RecipesModal
CommandsModal
MessagesModal
StructuresModal
EntityPaletteModal
TerrainPaletteModal
RobotsModal
DescriptionModal Entity
GoalModal

Instances

Instances details

Show MidScenarioModalType Source #
Instance details Defined in Swarm.TUI.Model.Menu Methods showsPrec :: Int -> MidScenarioModalType -> ShowS # show :: MidScenarioModalType -> String # showList :: [MidScenarioModalType] -> ShowS #
Eq MidScenarioModalType Source #
Instance details Defined in Swarm.TUI.Model.Menu Methods (==) :: MidScenarioModalType -> MidScenarioModalType -> Bool # (/=) :: MidScenarioModalType -> MidScenarioModalType -> Bool #

data EndScenarioModalType Source #

Constructors

ScenarioFinishModal ScenarioOutcome
QuitModal
KeepPlayingModal

Instances

Instances details

Show EndScenarioModalType Source #
Instance details Defined in Swarm.TUI.Model.Menu Methods showsPrec :: Int -> EndScenarioModalType -> ShowS # show :: EndScenarioModalType -> String # showList :: [EndScenarioModalType] -> ShowS #
Eq EndScenarioModalType Source #
Instance details Defined in Swarm.TUI.Model.Menu Methods (==) :: EndScenarioModalType -> EndScenarioModalType -> Bool # (/=) :: EndScenarioModalType -> EndScenarioModalType -> Bool #

data ModalType Source #

Constructors

MidScenarioModal MidScenarioModalType
EndScenarioModal EndScenarioModalType

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 #
Eq ModalType Source #
Instance details Defined in Swarm.TUI.Model.Menu Methods (==) :: ModalType -> ModalType -> Bool # (/=) :: ModalType -> ModalType -> Bool #

data ButtonAction Source #

Constructors

Cancel
KeepPlaying
StartOver Seed (ScenarioWith ScenarioPath)
QuitAction
Next (NonEmpty (ScenarioWith ScenarioPath))

data Modal Source #

Constructors

Modal
Fields _modalType :: ModalType _modalDialog :: Dialog ButtonAction Name

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

modalType :: Lens' Modal ModalType 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 ScenarioPath)))	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 #

_NoMenu :: Prism' Menu () Source #

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

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

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

_MessagesMenu :: Prism' Menu () Source #

_AboutMenu :: Prism' Menu () Source #

mkScenarioList :: ScenarioCollection a -> List Name (ScenarioItem a) Source #

Create a brick List of scenario items from a ScenarioCollection.

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 #

_Separator :: Prism' InventoryListEntry Text Source #

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

_EquippedEntry :: Prism' InventoryListEntry Entity Source #