Swarm.TUI.Model.UI

Documentation

data UIState

Constructors

UIState

Fields

• _uiMenu :: Menu
• _uiPlaying :: Bool
• _uiCheatMode :: Bool
• _uiLaunchConfig :: LaunchOptions
• _uiAchievements :: Map CategorizedAchievement Attainment
• _uiAttrMap :: AttrMap
• _uiGameplay :: UIGameplay
• _uiPopups :: PopupState

data UIGameplay

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

Constructors

UIGameplay

Fields

• _uiFocusRing :: FocusRing Name
• _uiWorldCursor :: Maybe (Cosmic Coords)
• _uiWorldEditor :: WorldEditor Name
• _uiREPL :: REPLState
• _uiInventory :: UIInventory
• _uiScrollToEnd :: Bool
• _uiModal :: Maybe Modal
• _uiGoal :: GoalDisplay
• _uiStructure :: StructureDisplay
• _uiHideGoals :: Bool
• _uiShowREPL :: Bool
• _uiShowDebug :: Bool
• _uiHideRobotsUntil :: TimeSpec
• _uiTiming :: UITiming
• _scenarioRef :: Maybe ScenarioInfoPair

data UITiming

Constructors

UITiming

Fields

• _uiShowFPS :: Bool
• _uiTPF :: Double
• _uiFPS :: Double
• _lgTicksPerSecond :: Int
• _tickCount :: Int
• _frameCount :: Int
• _frameTickCount :: Int
• _lastFrameTime :: TimeSpec
• _accumulatedTime :: TimeSpec
• _lastInfoTime :: TimeSpec

data UIInventory

Constructors

UIInventory

Fields

• _uiInventoryList :: Maybe (Int, List Name InventoryListEntry)
• _uiInventorySort :: InventorySortOptions
• _uiInventorySearch :: Maybe Text
• _uiShowZero :: Bool
• _uiInventoryShouldUpdate :: Bool

data GoalDisplay

Constructors

GoalDisplay

Fields

• _goalsContent :: GoalTracking
• _listWidget :: List Name GoalEntry

  required for maintaining the selection/navigation state among list items

• _focus :: FocusRing Name

uiGameplay :: Lens' UIState UIGameplay

UI active during live gameplay

uiPopups :: Lens' UIState PopupState

Queue of popups to display

uiTiming :: Lens' UIGameplay UITiming

Temporal information for gameplay UI

uiInventory :: Lens' UIGameplay UIInventory

Inventory information for gameplay UI

uiMenu :: Lens' UIState Menu

The current menu state.

uiPlaying :: Lens' UIState Bool

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.

uiCheatMode :: Lens' UIState Bool

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

uiFocusRing :: Lens' UIGameplay (FocusRing Name)

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

uiLaunchConfig :: Lens' UIState LaunchOptions

Configuration modal when launching a scenario

uiWorldCursor :: Lens' UIGameplay (Maybe (Cosmic Coords))

The last clicked position on the world view.

uiWorldEditor :: Lens' UIGameplay (WorldEditor Name)

State of all World Editor widgets

uiREPL :: Lens' UIGameplay REPLState

The state of REPL panel.

uiInventoryList :: Lens' UIInventory (Maybe (Int, List Name InventoryListEntry))

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.

uiInventorySort :: Lens' UIInventory InventorySortOptions

The order and direction of sorting inventory list.

uiInventorySearch :: Lens' UIInventory (Maybe Text)

The current search string used to narrow the inventory view.

uiScrollToEnd :: Lens' UIGameplay Bool

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

uiModal :: Lens' UIGameplay (Maybe Modal)

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

uiGoal :: Lens' UIGameplay GoalDisplay

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

uiStructure :: Lens' UIGameplay StructureDisplay

Definition and status of a recognizable structure

uiHideGoals :: Lens' UIGameplay Bool

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

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

uiAchievements :: Lens' UIState (Map CategorizedAchievement Attainment)

Map of achievements that were attained

lgTicksPerSecond :: Lens' UITiming Int

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

lastFrameTime :: Lens' UITiming TimeSpec

The time of the last Frame event.

accumulatedTime :: Lens' UITiming TimeSpec

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/ .

tickCount :: Lens' UITiming Int

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

frameCount :: Lens' UITiming Int

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

frameTickCount :: Lens' UITiming Int

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.

lastInfoTime :: Lens' UITiming TimeSpec

The time of the last info widget update

uiShowFPS :: Lens' UITiming Bool

A toggle to show the FPS by pressing f

uiShowREPL :: Lens' UIGameplay Bool

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

uiShowZero :: Lens' UIInventory Bool

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

uiShowDebug :: Lens' UIGameplay Bool

A toggle to show debug.

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

uiShowRobots :: Getter UIGameplay Bool

Whether to show or hide robots on the world map.

uiHideRobotsUntil :: Lens' UIGameplay TimeSpec

Hide robots on the world map.

uiInventoryShouldUpdate :: Lens' UIInventory Bool

Whether the Inventory ui panel should update

uiTPF :: Lens' UITiming Double

Computed ticks per milliseconds

uiFPS :: Lens' UITiming Double

Computed frames per milliseconds

uiAttrMap :: Lens' UIState AttrMap

Attribute map

scenarioRef :: Lens' UIGameplay (Maybe ScenarioInfoPair)

The currently active Scenario description, useful for starting over.

Initialization

initFocusRing :: FocusRing Name

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.

defaultInitLgTicksPerSecond :: Int

The initial tick speed.

initUIState :: (Has (Accum (Seq SystemFailure)) sig m, Has (Lift IO) sig m) => Int -> Bool -> Bool -> m UIState

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.