Swarm.Game.ScenarioInfo

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

Scenario info

data ScenarioStatus

A ScenarioStatus stores the status of a scenario along with appropriate metadata: NotStarted, or Played. The Played status has two sub-states: Attempted or Completed.

Constructors

NotStarted

Played SerializableLaunchParams ProgressMetric BestRecords

Instances

FromJSON ScenarioStatus

Defined in Swarm.Game.Scenario.Status

Methods

parseJSON :: Value -> Parser ScenarioStatus

parseJSONList :: Value -> Parser [ScenarioStatus]

ToJSON ScenarioStatus

Defined in Swarm.Game.Scenario.Status

Methods

toJSON :: ScenarioStatus -> Value

toEncoding :: ScenarioStatus -> Encoding

toJSONList :: [ScenarioStatus] -> Value

toEncodingList :: [ScenarioStatus] -> Encoding

Generic ScenarioStatus

Defined in Swarm.Game.Scenario.Status

Associated Types

type Rep ScenarioStatus :: Type -> Type

Methods

from :: ScenarioStatus -> Rep ScenarioStatus x

to :: Rep ScenarioStatus x -> ScenarioStatus

Read ScenarioStatus

Defined in Swarm.Game.Scenario.Status

Methods

readsPrec :: Int -> ReadS ScenarioStatus

readList :: ReadS [ScenarioStatus]

readPrec :: ReadPrec ScenarioStatus

readListPrec :: ReadPrec [ScenarioStatus]

Show ScenarioStatus

Defined in Swarm.Game.Scenario.Status

Methods

showsPrec :: Int -> ScenarioStatus -> ShowS

show :: ScenarioStatus -> String

showList :: [ScenarioStatus] -> ShowS

Eq ScenarioStatus

Defined in Swarm.Game.Scenario.Status

Methods

(==) :: ScenarioStatus -> ScenarioStatus -> Bool

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

Ord ScenarioStatus

Defined in Swarm.Game.Scenario.Status

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

Defined in Swarm.Game.Scenario.Status

type Rep ScenarioStatus = D1 ('MetaData "ScenarioStatus" "Swarm.Game.Scenario.Status" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "NotStarted" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Played" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SerializableLaunchParams) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProgressMetric) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BestRecords))))

_NotStarted :: Prism' ScenarioStatus ()

data ScenarioInfo

A ScenarioInfo record stores metadata about a scenario: its canonical path and status. By way of the ScenarioStatus record, it stores the most recent status and best-ever status.

Constructors

ScenarioInfo

Fields

• _scenarioPath :: FilePath
• _scenarioStatus :: ScenarioStatus

Instances

FromJSON ScenarioInfo

Defined in Swarm.Game.Scenario.Status

Methods

parseJSON :: Value -> Parser ScenarioInfo

parseJSONList :: Value -> Parser [ScenarioInfo]

ToJSON ScenarioInfo

Defined in Swarm.Game.Scenario.Status

Methods

toJSON :: ScenarioInfo -> Value

toEncoding :: ScenarioInfo -> Encoding

toJSONList :: [ScenarioInfo] -> Value

toEncodingList :: [ScenarioInfo] -> Encoding

Generic ScenarioInfo

Defined in Swarm.Game.Scenario.Status

Associated Types

type Rep ScenarioInfo :: Type -> Type

Methods

from :: ScenarioInfo -> Rep ScenarioInfo x

to :: Rep ScenarioInfo x -> ScenarioInfo

Read ScenarioInfo

Defined in Swarm.Game.Scenario.Status

Methods

readsPrec :: Int -> ReadS ScenarioInfo

readList :: ReadS [ScenarioInfo]

readPrec :: ReadPrec ScenarioInfo

readListPrec :: ReadPrec [ScenarioInfo]

Show ScenarioInfo

Defined in Swarm.Game.Scenario.Status

Methods

showsPrec :: Int -> ScenarioInfo -> ShowS

show :: ScenarioInfo -> String

showList :: [ScenarioInfo] -> ShowS

Eq ScenarioInfo

Defined in Swarm.Game.Scenario.Status

Methods

(==) :: ScenarioInfo -> ScenarioInfo -> Bool

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

Ord ScenarioInfo

Defined in Swarm.Game.Scenario.Status

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

Defined in Swarm.Game.Scenario.Status

type Rep ScenarioInfo = D1 ('MetaData "ScenarioInfo" "Swarm.Game.Scenario.Status" "swarm-0.5.0.0-6qXEbhCmuXA4wRndqqhBu" 'False) (C1 ('MetaCons "ScenarioInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "_scenarioPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "_scenarioStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScenarioStatus)))

scenarioPath :: Lens' ScenarioInfo FilePath

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

scenarioStatus :: Lens' ScenarioInfo ScenarioStatus

The status of the scenario.

data CodeSizeDeterminators

Constructors

CodeSizeDeterminators (Maybe ProcessedTerm) Bool

Instances

Show CodeSizeDeterminators

Defined in Swarm.Game.Scenario.Scoring.CodeSize

Methods

showsPrec :: Int -> CodeSizeDeterminators -> ShowS

show :: CodeSizeDeterminators -> String

showList :: [CodeSizeDeterminators] -> ShowS

updateScenarioInfoOnFinish :: CodeSizeDeterminators -> ZonedTime -> TickNumber -> Bool -> ScenarioInfo -> ScenarioInfo

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.

type ScenarioInfoPair = (Scenario, ScenarioInfo)

Scenario collection

data ScenarioCollection

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

Show ScenarioCollection

Defined in Swarm.Game.ScenarioInfo

Methods

showsPrec :: Int -> ScenarioCollection -> ShowS

show :: ScenarioCollection -> String

showList :: [ScenarioCollection] -> ShowS

scenarioCollectionToList :: ScenarioCollection -> [ScenarioItem]

Convert a scenario collection to a list of scenario items.

flatten :: ScenarioItem -> [ScenarioInfoPair]

scenarioItemByPath :: FilePath -> Traversal' ScenarioCollection ScenarioItem

Access and modify ScenarioItems in collection based on their path.

normalizeScenarioPath :: MonadIO m => ScenarioCollection -> FilePath -> m FilePath

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

data ScenarioItem

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

Constructors

SISingle ScenarioInfoPair

SICollection Text ScenarioCollection

Instances

Show ScenarioItem

Defined in Swarm.Game.ScenarioInfo

Methods

showsPrec :: Int -> ScenarioItem -> ShowS

show :: ScenarioItem -> String

showList :: [ScenarioItem] -> ShowS

scenarioItemName :: ScenarioItem -> Text

Retrieve the name of a scenario item.

_SISingle :: Prism' ScenarioItem ScenarioInfoPair

Loading and saving scenarios

loadScenarios :: (Has (Accum (Seq SystemFailure)) sig m, Has (Lift IO) sig m) => EntityMap -> WorldMap -> m ScenarioCollection

Load all the scenarios from the scenarios data directory.

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

Load saved info about played scenario from XDG data directory.

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

Save info about played scenario to XDG data directory.

Re-exports

module Swarm.Game.Scenario