License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.TUI.Model.Goal

Description

A UI-centric model for Objective presentation.

Synopsis

data GoalStatus
- = Upcoming
- | Active
- | Completed
- | Failed
type CategorizedGoals = Map GoalStatus (NonEmpty Objective)
data GoalEntry
- = Header GoalStatus
- | Goal GoalStatus Objective
- | Spacer
shouldSkipSelection :: GoalEntry -> Bool
data GoalTracking = GoalTracking {
- announcements :: [Announcement]
- goals :: CategorizedGoals
}
data GoalDisplay = GoalDisplay {
- _goalsContent :: GoalTracking
- _listWidget :: List Name GoalEntry
- _focus :: FocusRing Name
}
listWidget :: Lens' GoalDisplay (List Name GoalEntry)
goalsContent :: Lens' GoalDisplay GoalTracking
focus :: Lens' GoalDisplay (FocusRing Name)
emptyGoalDisplay :: GoalDisplay
hasAnythingToShow :: GoalTracking -> Bool
hasMultipleGoals :: GoalTracking -> Bool
constructGoalMap :: Bool -> ObjectiveCompletion -> CategorizedGoals

Documentation

data GoalStatus Source #

These are intended to be used as keys in a map of lists of goals.

Constructors

Upcoming	Goals in this category have other goals as prerequisites. However, they are only displayed if the "previewable" attribute is `true`.
Active	Goals in this category may be pursued in parallel. However, they are only displayed if the "hidden" attribute is `false`.
Completed	A goal's programmatic condition, as well as all its prerequisites, were completed. This is a "latch" mechanism; at some point the conditions required to meet the goal may no longer hold. Nonetheless, the goal remains "completed".
Failed	A goal that can no longer be achieved. If this goal is not an "optional" goal, then the player also "loses" the scenario. Note that currently the only way to "fail" a goal is by way of a negative prerequisite that was completed.

Instances

Instances details

ToJSON GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods toJSON :: GoalStatus -> Value # toEncoding :: GoalStatus -> Encoding # toJSONList :: [GoalStatus] -> Value # toEncodingList :: [GoalStatus] -> Encoding #
ToJSONKey GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods toJSONKey :: ToJSONKeyFunction GoalStatus # toJSONKeyList :: ToJSONKeyFunction [GoalStatus] #
Bounded GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods minBound :: GoalStatus # maxBound :: GoalStatus #
Enum GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods succ :: GoalStatus -> GoalStatus # pred :: GoalStatus -> GoalStatus # toEnum :: Int -> GoalStatus # fromEnum :: GoalStatus -> Int # enumFrom :: GoalStatus -> [GoalStatus] # enumFromThen :: GoalStatus -> GoalStatus -> [GoalStatus] # enumFromTo :: GoalStatus -> GoalStatus -> [GoalStatus] # enumFromThenTo :: GoalStatus -> GoalStatus -> GoalStatus -> [GoalStatus] #
Generic GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Associated Types type Rep GoalStatus :: Type -> Type # Methods from :: GoalStatus -> Rep GoalStatus x # to :: Rep GoalStatus x -> GoalStatus #
Show GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods showsPrec :: Int -> GoalStatus -> ShowS # show :: GoalStatus -> String # showList :: [GoalStatus] -> ShowS #
Eq GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods (==) :: GoalStatus -> GoalStatus -> Bool # (/=) :: GoalStatus -> GoalStatus -> Bool #
Ord GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods compare :: GoalStatus -> GoalStatus -> Ordering # (<) :: GoalStatus -> GoalStatus -> Bool # (<=) :: GoalStatus -> GoalStatus -> Bool # (>) :: GoalStatus -> GoalStatus -> Bool # (>=) :: GoalStatus -> GoalStatus -> Bool # max :: GoalStatus -> GoalStatus -> GoalStatus # min :: GoalStatus -> GoalStatus -> GoalStatus #
type Rep GoalStatus Source #
Instance details Defined in Swarm.TUI.Model.Goal type Rep GoalStatus = D1 ('MetaData "GoalStatus" "Swarm.TUI.Model.Goal" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) ((C1 ('MetaCons "Upcoming" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Completed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Failed" 'PrefixI 'False) (U1 :: Type -> Type)))

type CategorizedGoals = Map GoalStatus (NonEmpty Objective) Source #

data GoalEntry Source #

Constructors

Header GoalStatus
Goal GoalStatus Objective
Spacer

shouldSkipSelection :: GoalEntry -> Bool Source #

data GoalTracking Source #

Constructors

GoalTracking
Fields announcements :: [Announcement] TODO: #1044 the actual contents of these are not used yet, other than as a flag to pop up the Goal dialog. goals :: CategorizedGoals

Instances

Instances details

ToJSON GoalTracking Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods toJSON :: GoalTracking -> Value # toEncoding :: GoalTracking -> Encoding # toJSONList :: [GoalTracking] -> Value # toEncodingList :: [GoalTracking] -> Encoding #
Generic GoalTracking Source #
Instance details Defined in Swarm.TUI.Model.Goal Associated Types type Rep GoalTracking :: Type -> Type # Methods from :: GoalTracking -> Rep GoalTracking x # to :: Rep GoalTracking x -> GoalTracking #
ToSample GoalTracking Source #
Instance details Defined in Swarm.TUI.Model.Goal Methods toSamples :: Proxy GoalTracking -> [(Text, GoalTracking)] #
type Rep GoalTracking Source #
Instance details Defined in Swarm.TUI.Model.Goal type Rep GoalTracking = D1 ('MetaData "GoalTracking" "Swarm.TUI.Model.Goal" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "GoalTracking" 'PrefixI 'True) (S1 ('MetaSel ('Just "announcements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Announcement]) :*: S1 ('MetaSel ('Just "goals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CategorizedGoals)))

data GoalDisplay Source #

Constructors

GoalDisplay
Fields _goalsContent :: GoalTracking _listWidget :: List Name GoalEntry required for maintaining the selection/navigation state among list items _focus :: FocusRing Name

listWidget :: Lens' GoalDisplay (List Name GoalEntry) Source #

goalsContent :: Lens' GoalDisplay GoalTracking Source #

focus :: Lens' GoalDisplay (FocusRing Name) Source #

emptyGoalDisplay :: GoalDisplay Source #

hasAnythingToShow :: GoalTracking -> Bool Source #

hasMultipleGoals :: GoalTracking -> Bool Source #

constructGoalMap :: Bool -> ObjectiveCompletion -> CategorizedGoals Source #