Copyright	Brent Yorgey
License	BSD-3-Clause
Maintainer	byorgey@gmail.com
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Game.ScenarioInfo

Contents

Scenario info
Scenario collection
Loading and saving scenarios
Re-exports
Orphan instances

Description

Saving and loading info about scenarios (status, path, etc.) as well as loading recursive scenario collections.

Synopsis

data ScenarioStatus
- = NotStarted
- | InProgress {
  }
- | Complete {
  }
_NotStarted :: Prism' ScenarioStatus ()
_InProgress :: Prism' ScenarioStatus (ZonedTime, NominalDiffTime, Integer)
_Complete :: Prism' ScenarioStatus (ZonedTime, NominalDiffTime, Integer)
data ScenarioInfo = ScenarioInfo {
- _scenarioPath :: FilePath
- _scenarioStatus :: ScenarioStatus
- _scenarioBestTime :: ScenarioStatus
- _scenarioBestTicks :: ScenarioStatus
}
scenarioPath :: Lens' ScenarioInfo FilePath
scenarioStatus :: Lens' ScenarioInfo ScenarioStatus
scenarioBestTime :: Lens' ScenarioInfo ScenarioStatus
scenarioBestTicks :: Lens' ScenarioInfo ScenarioStatus
updateScenarioInfoOnQuit :: ZonedTime -> Integer -> Bool -> ScenarioInfo -> ScenarioInfo
data ScenarioCollection = SC {
- scOrder :: Maybe [FilePath]
- scMap :: Map FilePath ScenarioItem
}
scenarioCollectionToList :: ScenarioCollection -> [ScenarioItem]
scenarioItemByPath :: FilePath -> Traversal' ScenarioCollection ScenarioItem
normalizeScenarioPath :: ScenarioCollection -> FilePath -> IO FilePath
data ScenarioItem
- = SISingle Scenario ScenarioInfo
- | SICollection Text ScenarioCollection
scenarioItemName :: ScenarioItem -> Text
_SISingle :: Prism' ScenarioItem (Scenario, ScenarioInfo)
loadScenarios :: Has (Lift IO) sig m => EntityMap -> m (Either Text ScenarioCollection)
loadScenarioInfo :: (Has (Lift IO) sig m, Has (Throw Text) sig m) => FilePath -> m ScenarioInfo
saveScenarioInfo :: FilePath -> ScenarioInfo -> IO ()
module Swarm.Game.Scenario

Scenario info

data ScenarioStatus Source #

A ScenarioStatus stores the status of a scenario along with appropriate metadata: not started, in progress, or complete. Note that "in progress" is currently a bit of a misnomer since games cannot be saved; at the moment it really means more like "you played this scenario before but didn't win".

Constructors

NotStarted
InProgress
Fields _scenarioStarted :: ZonedTime Time when the scenario was started including time zone. _scenarioElapsed :: NominalDiffTime Time elapsed until quitting the scenario. _scenarioElapsedTicks :: Integer Ticks elapsed until quitting the scenario.
Complete
Fields _scenarioStarted :: ZonedTime Time when the scenario was started including time zone. _scenarioElapsed :: NominalDiffTime Time elapsed until quitting the scenario. _scenarioElapsedTicks :: Integer Ticks elapsed until quitting the scenario.

Instances

Instances details

FromJSON ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods parseJSON :: Value -> Parser ScenarioStatus # parseJSONList :: Value -> Parser [ScenarioStatus] #
ToJSON ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods toJSON :: ScenarioStatus -> Value # toEncoding :: ScenarioStatus -> Encoding # toJSONList :: [ScenarioStatus] -> Value # toEncodingList :: [ScenarioStatus] -> Encoding #
Generic ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Associated Types type Rep ScenarioStatus :: Type -> Type # Methods from :: ScenarioStatus -> Rep ScenarioStatus x # to :: Rep ScenarioStatus x -> ScenarioStatus #
Read ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods readsPrec :: Int -> ReadS ScenarioStatus # readList :: ReadS [ScenarioStatus] # readPrec :: ReadPrec ScenarioStatus # readListPrec :: ReadPrec [ScenarioStatus] #
Show ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods showsPrec :: Int -> ScenarioStatus -> ShowS # show :: ScenarioStatus -> String # showList :: [ScenarioStatus] -> ShowS #
Eq ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods (==) :: ScenarioStatus -> ScenarioStatus -> Bool # (/=) :: ScenarioStatus -> ScenarioStatus -> Bool #
Ord ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods compare :: ScenarioStatus -> ScenarioStatus -> Ordering # (<) :: ScenarioStatus -> ScenarioStatus -> Bool # (<=) :: ScenarioStatus -> ScenarioStatus -> Bool # (>) :: ScenarioStatus -> ScenarioStatus -> Bool # (>=) :: ScenarioStatus -> ScenarioStatus -> Bool # max :: ScenarioStatus -> ScenarioStatus -> ScenarioStatus # min :: ScenarioStatus -> ScenarioStatus -> ScenarioStatus #
type Rep ScenarioStatus Source #
Instance details Defined in Swarm.Game.ScenarioInfo type Rep ScenarioStatus = D1 ('MetaData "ScenarioStatus" "Swarm.Game.ScenarioInfo" "swarm-0.1.0.0-CFIPFkeeTOhKLDsfeG4aYn" 'False) (C1 ('MetaCons "NotStarted" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "InProgress" 'PrefixI 'True) (S1 ('MetaSel ('Just "_scenarioStarted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ZonedTime) :: (S1 ('MetaSel ('Just "_scenarioElapsed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NominalDiffTime) :: S1 ('MetaSel ('Just "_scenarioElapsedTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) :+: C1 ('MetaCons "Complete" 'PrefixI 'True) (S1 ('MetaSel ('Just "_scenarioStarted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ZonedTime) :: (S1 ('MetaSel ('Just "_scenarioElapsed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NominalDiffTime) :: S1 ('MetaSel ('Just "_scenarioElapsedTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)))))

_NotStarted :: Prism' ScenarioStatus () Source #

_InProgress :: Prism' ScenarioStatus (ZonedTime, NominalDiffTime, Integer) Source #

_Complete :: Prism' ScenarioStatus (ZonedTime, NominalDiffTime, Integer) Source #

data ScenarioInfo Source #

A ScenarioInfo record stores metadata about a scenario: its canonical path, most recent status, and best-ever status.

Constructors

ScenarioInfo
Fields _scenarioPath :: FilePath _scenarioStatus :: ScenarioStatus _scenarioBestTime :: ScenarioStatus _scenarioBestTicks :: ScenarioStatus

Instances

Instances details

FromJSON ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods parseJSON :: Value -> Parser ScenarioInfo # parseJSONList :: Value -> Parser [ScenarioInfo] #
ToJSON ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods toJSON :: ScenarioInfo -> Value # toEncoding :: ScenarioInfo -> Encoding # toJSONList :: [ScenarioInfo] -> Value # toEncodingList :: [ScenarioInfo] -> Encoding #
Generic ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Associated Types type Rep ScenarioInfo :: Type -> Type # Methods from :: ScenarioInfo -> Rep ScenarioInfo x # to :: Rep ScenarioInfo x -> ScenarioInfo #
Read ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods readsPrec :: Int -> ReadS ScenarioInfo # readList :: ReadS [ScenarioInfo] # readPrec :: ReadPrec ScenarioInfo # readListPrec :: ReadPrec [ScenarioInfo] #
Show ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods showsPrec :: Int -> ScenarioInfo -> ShowS # show :: ScenarioInfo -> String # showList :: [ScenarioInfo] -> ShowS #
Eq ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods (==) :: ScenarioInfo -> ScenarioInfo -> Bool # (/=) :: ScenarioInfo -> ScenarioInfo -> Bool #
Ord ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods compare :: ScenarioInfo -> ScenarioInfo -> Ordering # (<) :: ScenarioInfo -> ScenarioInfo -> Bool # (<=) :: ScenarioInfo -> ScenarioInfo -> Bool # (>) :: ScenarioInfo -> ScenarioInfo -> Bool # (>=) :: ScenarioInfo -> ScenarioInfo -> Bool # max :: ScenarioInfo -> ScenarioInfo -> ScenarioInfo # min :: ScenarioInfo -> ScenarioInfo -> ScenarioInfo #
type Rep ScenarioInfo Source #
Instance details Defined in Swarm.Game.ScenarioInfo type Rep ScenarioInfo = D1 ('MetaData "ScenarioInfo" "Swarm.Game.ScenarioInfo" "swarm-0.1.0.0-CFIPFkeeTOhKLDsfeG4aYn" 'False) (C1 ('MetaCons "ScenarioInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_scenarioPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath) :: S1 ('MetaSel ('Just "_scenarioStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScenarioStatus)) :: (S1 ('MetaSel ('Just "_scenarioBestTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScenarioStatus) :*: S1 ('MetaSel ('Just "_scenarioBestTicks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScenarioStatus))))

scenarioPath :: Lens' ScenarioInfo FilePath Source #

The path of the scenario, relative to data/scenarios.

scenarioStatus :: Lens' ScenarioInfo ScenarioStatus Source #

The status of the scenario.

scenarioBestTime :: Lens' ScenarioInfo ScenarioStatus Source #

The best status of the scenario, measured in real world time.

scenarioBestTicks :: Lens' ScenarioInfo ScenarioStatus Source #

The best status of the scenario, measured in game ticks.

updateScenarioInfoOnQuit :: ZonedTime -> Integer -> Bool -> ScenarioInfo -> ScenarioInfo Source #

Update the current ScenarioInfo record when quitting a game.

Note that when comparing "best" times, shorter is not always better! As long as the scenario is not completed (e.g. some do not have win condition) we consider having fun _longer_ to be better.

Scenario collection

data ScenarioCollection Source #

A scenario collection is a tree of scenarios, keyed by name, together with an optional order. Invariant: every item in the scOrder exists as a key in the scMap.

Constructors

SC
Fields scOrder :: Maybe [FilePath] scMap :: Map FilePath ScenarioItem

Instances

Instances details

Show ScenarioCollection Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods showsPrec :: Int -> ScenarioCollection -> ShowS # show :: ScenarioCollection -> String # showList :: [ScenarioCollection] -> ShowS #
Eq ScenarioCollection Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods (==) :: ScenarioCollection -> ScenarioCollection -> Bool # (/=) :: ScenarioCollection -> ScenarioCollection -> Bool #

scenarioCollectionToList :: ScenarioCollection -> [ScenarioItem] Source #

Convert a scenario collection to a list of scenario items.

scenarioItemByPath :: FilePath -> Traversal' ScenarioCollection ScenarioItem Source #

Access and modify ScenarioItems in collection based on their path.

normalizeScenarioPath :: ScenarioCollection -> FilePath -> IO FilePath Source #

Canonicalize a scenario path, making it usable as a unique key.

data ScenarioItem Source #

A scenario item is either a specific scenario, or a collection of scenarios (*e.g.* the scenarios contained in a subdirectory).

Constructors

SISingle Scenario ScenarioInfo
SICollection Text ScenarioCollection

Instances

Instances details

Show ScenarioItem Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods showsPrec :: Int -> ScenarioItem -> ShowS # show :: ScenarioItem -> String # showList :: [ScenarioItem] -> ShowS #
Eq ScenarioItem Source #
Instance details Defined in Swarm.Game.ScenarioInfo Methods (==) :: ScenarioItem -> ScenarioItem -> Bool # (/=) :: ScenarioItem -> ScenarioItem -> Bool #

scenarioItemName :: ScenarioItem -> Text Source #

Retrieve the name of a scenario item.

_SISingle :: Prism' ScenarioItem (Scenario, ScenarioInfo) Source #

Loading and saving scenarios

loadScenarios :: Has (Lift IO) sig m => EntityMap -> m (Either Text ScenarioCollection) Source #

Load all the scenarios from the scenarios data directory.

loadScenarioInfo :: (Has (Lift IO) sig m, Has (Throw Text) sig m) => FilePath -> m ScenarioInfo Source #

Load saved info about played scenario from XDG data directory.

saveScenarioInfo :: FilePath -> ScenarioInfo -> IO () Source #

Save info about played scenario to XDG data directory.

Re-exports

module Swarm.Game.Scenario

Orphan instances

Eq ZonedTime Source #
Instance details Methods (==) :: ZonedTime -> ZonedTime -> Bool # (/=) :: ZonedTime -> ZonedTime -> Bool #
Ord ZonedTime Source #
Instance details Methods compare :: ZonedTime -> ZonedTime -> Ordering # (<) :: ZonedTime -> ZonedTime -> Bool # (<=) :: ZonedTime -> ZonedTime -> Bool # (>) :: ZonedTime -> ZonedTime -> Bool # (>=) :: ZonedTime -> ZonedTime -> Bool # max :: ZonedTime -> ZonedTime -> ZonedTime # min :: ZonedTime -> ZonedTime -> ZonedTime #