Swarm.Game.Scenario.Objective.Presentation.Model

Documentation

data GoalStatus

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

ToJSON GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

toJSON :: GoalStatus -> Value

toEncoding :: GoalStatus -> Encoding

toJSONList :: [GoalStatus] -> Value

toEncodingList :: [GoalStatus] -> Encoding

ToJSONKey GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

toJSONKey :: ToJSONKeyFunction GoalStatus

toJSONKeyList :: ToJSONKeyFunction [GoalStatus]

Bounded GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

minBound :: GoalStatus

maxBound :: GoalStatus

Enum GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

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

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Associated Types

type Rep GoalStatus :: Type -> Type

Methods

from :: GoalStatus -> Rep GoalStatus x

to :: Rep GoalStatus x -> GoalStatus

Show GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

showsPrec :: Int -> GoalStatus -> ShowS

show :: GoalStatus -> String

showList :: [GoalStatus] -> ShowS

Eq GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

(==) :: GoalStatus -> GoalStatus -> Bool

(/=) :: GoalStatus -> GoalStatus -> Bool

Ord GoalStatus

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

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

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

type Rep GoalStatus = D1 ('MetaData "GoalStatus" "Swarm.Game.Scenario.Objective.Presentation.Model" "swarm-0.3.0.1-EqejWKaUFCJHRV1d3nJuA2" '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)))

newtype Announcement

TODO: #1044 Could also add an ObjectiveFailed constructor...

Constructors

ObjectiveCompleted Objective

Instances

ToJSON Announcement

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

toJSON :: Announcement -> Value

toEncoding :: Announcement -> Encoding

toJSONList :: [Announcement] -> Value

toEncodingList :: [Announcement] -> Encoding

Generic Announcement

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Associated Types

type Rep Announcement :: Type -> Type

Methods

from :: Announcement -> Rep Announcement x

to :: Rep Announcement x -> Announcement

Show Announcement

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

showsPrec :: Int -> Announcement -> ShowS

show :: Announcement -> String

showList :: [Announcement] -> ShowS

type Rep Announcement

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

type Rep Announcement = D1 ('MetaData "Announcement" "Swarm.Game.Scenario.Objective.Presentation.Model" "swarm-0.3.0.1-EqejWKaUFCJHRV1d3nJuA2" 'True) (C1 ('MetaCons "ObjectiveCompleted" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Objective)))

type CategorizedGoals = Map GoalStatus (NonEmpty Objective)

data GoalEntry

Constructors

Header GoalStatus

Goal GoalStatus Objective

isHeader :: GoalEntry -> Bool

data GoalTracking

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

ToJSON GoalTracking

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Methods

toJSON :: GoalTracking -> Value

toEncoding :: GoalTracking -> Encoding

toJSONList :: [GoalTracking] -> Value

toEncodingList :: [GoalTracking] -> Encoding

Generic GoalTracking

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

Associated Types

type Rep GoalTracking :: Type -> Type

Methods

from :: GoalTracking -> Rep GoalTracking x

to :: Rep GoalTracking x -> GoalTracking

type Rep GoalTracking

Defined in Swarm.Game.Scenario.Objective.Presentation.Model

type Rep GoalTracking = D1 ('MetaData "GoalTracking" "Swarm.Game.Scenario.Objective.Presentation.Model" "swarm-0.3.0.1-EqejWKaUFCJHRV1d3nJuA2" '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

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)

goalsContent :: Lens' GoalDisplay GoalTracking

focus :: Lens' GoalDisplay (FocusRing Name)

emptyGoalDisplay :: GoalDisplay

hasAnythingToShow :: GoalTracking -> Bool

hasMultipleGoals :: GoalTracking -> Bool

constructGoalMap :: Bool -> ObjectiveCompletion -> CategorizedGoals