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

Swarm.Game.Scenario.Objective

Description

Synopsis

data PrerequisiteConfig = PrerequisiteConfig {
- previewable :: Bool
- logic :: Prerequisite ObjectiveLabel
}
data Objective = Objective {
- _objectiveGoal :: Document Syntax
- _objectiveTeaser :: Maybe Text
- _objectiveCondition :: ProcessedTerm
- _objectiveId :: Maybe ObjectiveLabel
- _objectiveOptional :: Bool
- _objectivePrerequisite :: Maybe PrerequisiteConfig
- _objectiveHidden :: Bool
- _objectiveAchievement :: Maybe AchievementInfo
}
objectiveGoal :: Lens' Objective (Document Syntax)
objectiveTeaser :: Lens' Objective (Maybe Text)
objectiveCondition :: Lens' Objective ProcessedTerm
objectiveId :: Lens' Objective (Maybe Text)
objectiveOptional :: Lens' Objective Bool
objectivePrerequisite :: Lens' Objective (Maybe PrerequisiteConfig)
objectiveHidden :: Lens' Objective Bool
objectiveAchievement :: Lens' Objective (Maybe AchievementInfo)
data CompletionBuckets = CompletionBuckets {
- incomplete :: [Objective]
- completed :: [Objective]
- unwinnable :: [Objective]
}
newtype Announcement = ObjectiveCompleted Objective
data ObjectiveCompletion = ObjectiveCompletion {
- completionBuckets :: CompletionBuckets
- completedIDs :: Set ObjectiveLabel
}
listAllObjectives :: CompletionBuckets -> [Objective]
addCompleted :: Objective -> ObjectiveCompletion -> ObjectiveCompletion
addUnwinnable :: Objective -> ObjectiveCompletion -> ObjectiveCompletion
setIncomplete :: ([Objective] -> [Objective]) -> ObjectiveCompletion -> ObjectiveCompletion
addIncomplete :: Objective -> ObjectiveCompletion -> ObjectiveCompletion
extractIncomplete :: ObjectiveCompletion -> (ObjectiveCompletion, [Objective])

Documentation

data PrerequisiteConfig Source #

Constructors

PrerequisiteConfig

Fields

previewable :: Bool
Typically, only the currently "active" objectives are displayed to the user in the Goals dialog. An objective is "active" if all of its prerequisites are met.
However, some objectives may be "high-level", in that they may explain the broader intention behind potentially multiple prerequisites.
Set this option to True to display this goal in the "upcoming" section even if the objective has currently unmet prerequisites.
logic :: Prerequisite ObjectiveLabel
Boolean expression of dependencies upon other objectives. Variables in this expression are the "id"s of other objectives, and become "true" if the corresponding objective is completed. The "condition" of the objective at hand shall not be evaluated until its prerequisite expression evaluates as True.
Note that the achievement of these objective dependencies is persistent; once achieved, they still count even if their "condition" might not still hold. The condition is never re-evaluated once true.

Instances

Instances details

FromJSON PrerequisiteConfig Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods parseJSON :: Value -> Parser PrerequisiteConfig # parseJSONList :: Value -> Parser [PrerequisiteConfig] #
ToJSON PrerequisiteConfig Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods toJSON :: PrerequisiteConfig -> Value # toEncoding :: PrerequisiteConfig -> Encoding # toJSONList :: [PrerequisiteConfig] -> Value # toEncodingList :: [PrerequisiteConfig] -> Encoding #
Generic PrerequisiteConfig Source #
Instance details Defined in Swarm.Game.Scenario.Objective Associated Types type Rep PrerequisiteConfig :: Type -> Type # Methods from :: PrerequisiteConfig -> Rep PrerequisiteConfig x # to :: Rep PrerequisiteConfig x -> PrerequisiteConfig #
Show PrerequisiteConfig Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods showsPrec :: Int -> PrerequisiteConfig -> ShowS # show :: PrerequisiteConfig -> String # showList :: [PrerequisiteConfig] -> ShowS #
Eq PrerequisiteConfig Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods (==) :: PrerequisiteConfig -> PrerequisiteConfig -> Bool # (/=) :: PrerequisiteConfig -> PrerequisiteConfig -> Bool #
type Rep PrerequisiteConfig Source #
Instance details Defined in Swarm.Game.Scenario.Objective type Rep PrerequisiteConfig = D1 ('MetaData "PrerequisiteConfig" "Swarm.Game.Scenario.Objective" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "PrerequisiteConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "previewable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "logic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Prerequisite ObjectiveLabel))))

data Objective Source #

An objective is a condition to be achieved by a player in a scenario.

Constructors

Objective
Fields _objectiveGoal :: Document Syntax _objectiveTeaser :: Maybe Text _objectiveCondition :: ProcessedTerm _objectiveId :: Maybe ObjectiveLabel _objectiveOptional :: Bool _objectivePrerequisite :: Maybe PrerequisiteConfig _objectiveHidden :: Bool _objectiveAchievement :: Maybe AchievementInfo

Instances

Instances details

FromJSON Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods parseJSON :: Value -> Parser Objective # parseJSONList :: Value -> Parser [Objective] #
ToJSON Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods toJSON :: Objective -> Value # toEncoding :: Objective -> Encoding # toJSONList :: [Objective] -> Value # toEncodingList :: [Objective] -> Encoding #
Generic Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective Associated Types type Rep Objective :: Type -> Type # Methods from :: Objective -> Rep Objective x # to :: Rep Objective x -> Objective #
Show Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods showsPrec :: Int -> Objective -> ShowS # show :: Objective -> String # showList :: [Objective] -> ShowS #
Eq Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods (==) :: Objective -> Objective -> Bool # (/=) :: Objective -> Objective -> Bool #
ToSample Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods toSamples :: Proxy Objective -> [(Text, Objective)] #
ToJSON (SCC Objective) Source #
Instance details Defined in Swarm.Game.Scenario.Objective.Graph Methods toJSON :: SCC Objective -> Value # toEncoding :: SCC Objective -> Encoding # toJSONList :: [SCC Objective] -> Value # toEncodingList :: [SCC Objective] -> Encoding #
type Rep Objective Source #
Instance details Defined in Swarm.Game.Scenario.Objective type Rep Objective = D1 ('MetaData "Objective" "Swarm.Game.Scenario.Objective" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "Objective" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_objectiveGoal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Document Syntax)) :: S1 ('MetaSel ('Just "_objectiveTeaser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "_objectiveCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessedTerm) :: S1 ('MetaSel ('Just "_objectiveId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectiveLabel)))) :: ((S1 ('MetaSel ('Just "_objectiveOptional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "_objectivePrerequisite") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PrerequisiteConfig))) :: (S1 ('MetaSel ('Just "_objectiveHidden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_objectiveAchievement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AchievementInfo))))))

objectiveGoal :: Lens' Objective (Document Syntax) Source #

An explanation of the goal of the objective, shown to the player during play. It is represented as a list of paragraphs.

objectiveTeaser :: Lens' Objective (Maybe Text) Source #

A very short (3-5 words) description of the goal for displaying on the left side of the Objectives modal.

objectiveCondition :: Lens' Objective ProcessedTerm Source #

A winning condition for the objective, expressed as a program of type cmd bool. By default, this program will be run to completion every tick (the usual limits on the number of CESK steps per tick do not apply).

objectiveId :: Lens' Objective (Maybe Text) Source #

Optional name by which this objective may be referenced as a prerequisite for other objectives.

objectiveOptional :: Lens' Objective Bool Source #

Indicates whether the objective is not required in order to "win" the scenario. Useful for (potentially hidden) achievements. If the field is not supplied, it defaults to False (i.e. the objective is mandatory to "win").

objectivePrerequisite :: Lens' Objective (Maybe PrerequisiteConfig) Source #

Dependencies upon other objectives

objectiveHidden :: Lens' Objective Bool Source #

Whether the goal is displayed in the UI before completion. The goal will always be revealed after it is completed.

This attribute often goes along with an Achievement.

objectiveAchievement :: Lens' Objective (Maybe AchievementInfo) Source #

An optional achievement that is to be registered globally when this objective is completed.

data CompletionBuckets Source #

Constructors

CompletionBuckets
Fields incomplete :: [Objective] completed :: [Objective] unwinnable :: [Objective]

Instances

Instances details

FromJSON CompletionBuckets Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods parseJSON :: Value -> Parser CompletionBuckets # parseJSONList :: Value -> Parser [CompletionBuckets] #
ToJSON CompletionBuckets Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods toJSON :: CompletionBuckets -> Value # toEncoding :: CompletionBuckets -> Encoding # toJSONList :: [CompletionBuckets] -> Value # toEncodingList :: [CompletionBuckets] -> Encoding #
Generic CompletionBuckets Source #
Instance details Defined in Swarm.Game.Scenario.Objective Associated Types type Rep CompletionBuckets :: Type -> Type # Methods from :: CompletionBuckets -> Rep CompletionBuckets x # to :: Rep CompletionBuckets x -> CompletionBuckets #
Show CompletionBuckets Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods showsPrec :: Int -> CompletionBuckets -> ShowS # show :: CompletionBuckets -> String # showList :: [CompletionBuckets] -> ShowS #
type Rep CompletionBuckets Source #
Instance details Defined in Swarm.Game.Scenario.Objective type Rep CompletionBuckets = D1 ('MetaData "CompletionBuckets" "Swarm.Game.Scenario.Objective" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "CompletionBuckets" 'PrefixI 'True) (S1 ('MetaSel ('Just "incomplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Objective]) :: (S1 ('MetaSel ('Just "completed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Objective]) :: S1 ('MetaSel ('Just "unwinnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Objective]))))

newtype Announcement Source #

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

Constructors

ObjectiveCompleted Objective

Instances

Instances details

ToJSON Announcement Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods toJSON :: Announcement -> Value # toEncoding :: Announcement -> Encoding # toJSONList :: [Announcement] -> Value # toEncodingList :: [Announcement] -> Encoding #
Generic Announcement Source #
Instance details Defined in Swarm.Game.Scenario.Objective Associated Types type Rep Announcement :: Type -> Type # Methods from :: Announcement -> Rep Announcement x # to :: Rep Announcement x -> Announcement #
Show Announcement Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods showsPrec :: Int -> Announcement -> ShowS # show :: Announcement -> String # showList :: [Announcement] -> ShowS #
type Rep Announcement Source #
Instance details Defined in Swarm.Game.Scenario.Objective type Rep Announcement = D1 ('MetaData "Announcement" "Swarm.Game.Scenario.Objective" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'True) (C1 ('MetaCons "ObjectiveCompleted" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Objective)))

data ObjectiveCompletion Source #

Constructors

ObjectiveCompletion

Fields

completionBuckets :: CompletionBuckets
This is the authoritative "completion status" for all objectives. Note that there is a separate Set to store the completion status of prerequisite objectives, which must be carefully kept in sync with this. Those prerequisite objectives are required to have labels, but other objectives are not. Therefore only prerequisites exist in the completion map keyed by label.
completedIDs :: Set ObjectiveLabel

Instances

Instances details

FromJSON ObjectiveCompletion Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods parseJSON :: Value -> Parser ObjectiveCompletion # parseJSONList :: Value -> Parser [ObjectiveCompletion] #
ToJSON ObjectiveCompletion Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods toJSON :: ObjectiveCompletion -> Value # toEncoding :: ObjectiveCompletion -> Encoding # toJSONList :: [ObjectiveCompletion] -> Value # toEncodingList :: [ObjectiveCompletion] -> Encoding #
Generic ObjectiveCompletion Source #
Instance details Defined in Swarm.Game.Scenario.Objective Associated Types type Rep ObjectiveCompletion :: Type -> Type # Methods from :: ObjectiveCompletion -> Rep ObjectiveCompletion x # to :: Rep ObjectiveCompletion x -> ObjectiveCompletion #
Show ObjectiveCompletion Source #
Instance details Defined in Swarm.Game.Scenario.Objective Methods showsPrec :: Int -> ObjectiveCompletion -> ShowS # show :: ObjectiveCompletion -> String # showList :: [ObjectiveCompletion] -> ShowS #
type Rep ObjectiveCompletion Source #
Instance details Defined in Swarm.Game.Scenario.Objective type Rep ObjectiveCompletion = D1 ('MetaData "ObjectiveCompletion" "Swarm.Game.Scenario.Objective" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "ObjectiveCompletion" 'PrefixI 'True) (S1 ('MetaSel ('Just "completionBuckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CompletionBuckets) :*: S1 ('MetaSel ('Just "completedIDs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set ObjectiveLabel))))

listAllObjectives :: CompletionBuckets -> [Objective] Source #

Concatenates all incomplete and completed objectives.

addCompleted :: Objective -> ObjectiveCompletion -> ObjectiveCompletion Source #

addUnwinnable :: Objective -> ObjectiveCompletion -> ObjectiveCompletion Source #

setIncomplete :: ([Objective] -> [Objective]) -> ObjectiveCompletion -> ObjectiveCompletion Source #

addIncomplete :: Objective -> ObjectiveCompletion -> ObjectiveCompletion Source #

extractIncomplete :: ObjectiveCompletion -> (ObjectiveCompletion, [Objective]) Source #

Returns the ObjectiveCompletion with the "incomplete" goals extracted to a separate tuple member. This is intended as input to a "fold".