Swarm.TUI.Model.UI

Documentation

data UIState

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

Constructors

UIState

Fields

• _uiMenu :: Menu
• _uiPlaying :: Bool
• _uiCheatMode :: Bool
• _uiFocusRing :: FocusRing Name
• _uiWorldCursor :: Maybe Coords
• _uiREPL :: REPLState
• _uiInventory :: Maybe (Int, List Name InventoryListEntry)
• _uiInventorySort :: InventorySortOptions
• _uiMoreInfoTop :: Bool
• _uiMoreInfoBot :: Bool
• _uiScrollToEnd :: Bool
• _uiError :: Maybe Text
• _uiModal :: Maybe Modal
• _uiGoal :: GoalDisplay
• _uiAchievements :: Map CategorizedAchievement Attainment
• _uiShowFPS :: Bool
• _uiShowZero :: Bool
• _uiHideRobotsUntil :: TimeSpec
• _uiInventoryShouldUpdate :: Bool
• _uiTPF :: Double
• _uiFPS :: Double
• _lgTicksPerSecond :: Int
• _tickCount :: Int
• _frameCount :: Int
• _frameTickCount :: Int
• _lastFrameTime :: TimeSpec
• _accumulatedTime :: TimeSpec
• _lastInfoTime :: TimeSpec
• _appData :: Map Text Text
• _uiAttrMap :: AttrMap
• _scenarioRef :: Maybe ScenarioInfoPair

data GoalDisplay

Constructors

GoalDisplay

Fields

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

  required for maintaining the selection/navigation state among list items

• _focus :: FocusRing Name

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' UIState (FocusRing Name)

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

uiWorldCursor :: Lens' UIState (Maybe Coords)

The last clicked position on the world view.

uiREPL :: Lens' UIState REPLState

The state of REPL panel.

uiInventory :: Lens' UIState (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' UIState InventorySortOptions

The order and direction of sorting inventory list.

uiMoreInfoTop :: Lens' UIState Bool

Does the info panel contain more content past the top of the panel?

uiMoreInfoBot :: Lens' UIState Bool

Does the info panel contain more content past the bottom of the panel?

uiScrollToEnd :: Lens' UIState Bool

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

uiError :: Lens' UIState (Maybe Text)

When this is Just, it represents a popup box containing an error message that is shown on top of the rest of the UI.

uiModal :: Lens' UIState (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' UIState GoalDisplay

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

uiAchievements :: Lens' UIState (Map CategorizedAchievement Attainment)

Map of achievements that were attained

lgTicksPerSecond :: Lens' UIState 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' UIState TimeSpec

The time of the last Frame event.

accumulatedTime :: Lens' UIState 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' UIState Int

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

frameCount :: Lens' UIState Int

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

frameTickCount :: Lens' UIState 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' UIState TimeSpec

The time of the last info widget update

uiShowFPS :: Lens' UIState Bool

A toggle to show the FPS by pressing f

uiShowZero :: Lens' UIState Bool

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

uiShowRobots :: Getter UIState Bool

Whether to show or hide robots on the world map.

uiHideRobotsUntil :: Lens' UIState TimeSpec

Hide robots on the world map.

uiInventoryShouldUpdate :: Lens' UIState Bool

Whether the Inventory ui panel should update

uiTPF :: Lens' UIState Double

Computed ticks per milli seconds

uiFPS :: Lens' UIState Double

Computed frames per milli seconds

uiAttrMap :: Lens' UIState AttrMap

Attribute map

scenarioRef :: Lens' UIState (Maybe ScenarioInfoPair)

The currently active Scenario description, useful for starting over.

appData :: Lens' UIState (Map Text Text)

Free-form data loaded from the data directory, for things like the logo, about page, tutorial story, etc.

Initialization

initFocusRing :: FocusRing Name

The initial state of the focus ring.

initLgTicksPerSecond :: Int

The initial tick speed.

initUIState :: Bool -> Bool -> ExceptT Text IO ([SystemFailure], 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.