Swarm.Game.Scenario

Scenarios are standalone worlds with specific starting and winning conditions, which can be used both for building interactive tutorials and for standalone puzzles and scenarios.

Objectives

data Objective

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

Instances

FromJSON Objective

Defined in Swarm.Game.Scenario

Methods

parseJSON :: Value -> Parser Objective

parseJSONList :: Value -> Parser [Objective]

ToJSON Objective

Defined in Swarm.Game.Scenario

Methods

toJSON :: Objective -> Value

toEncoding :: Objective -> Encoding

toJSONList :: [Objective] -> Value

toEncodingList :: [Objective] -> Encoding

Generic Objective

Defined in Swarm.Game.Scenario

Associated Types

type Rep Objective :: Type -> Type

Methods

from :: Objective -> Rep Objective x

to :: Rep Objective x -> Objective

Show Objective

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> Objective -> ShowS

show :: Objective -> String

showList :: [Objective] -> ShowS

Eq Objective

Defined in Swarm.Game.Scenario

Methods

(==) :: Objective -> Objective -> Bool

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

type Rep Objective

Defined in Swarm.Game.Scenario

type Rep Objective = D1 ('MetaData "Objective" "Swarm.Game.Scenario" "swarm-0.1.0.0-CFIPFkeeTOhKLDsfeG4aYn" 'False) (C1 ('MetaCons "Objective" 'PrefixI 'True) (S1 ('MetaSel ('Just "_objectiveGoal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "_objectiveCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProcessedTerm)))

objectiveGoal :: Lens' Objective [Text]

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

objectiveCondition :: Lens' Objective ProcessedTerm

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).

WorldDescription

data Cell

A single cell in a world map, which contains a terrain value, and optionally an entity and robot.

Constructors

Cell

Fields

• cellTerrain :: TerrainType
• cellEntity :: Maybe Entity
• cellRobots :: [TRobot]

Instances

Show Cell

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> Cell -> ShowS

show :: Cell -> String

showList :: [Cell] -> ShowS

Eq Cell

Defined in Swarm.Game.Scenario

Methods

(==) :: Cell -> Cell -> Bool

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

data WorldDescription

A description of a world parsed from a YAML file.

Constructors

WorldDescription

Fields

• defaultTerrain :: Maybe Cell
• offsetOrigin :: Bool
• palette :: WorldPalette
• ul :: V2 Int64
• area :: [[Cell]]

Instances

Show WorldDescription

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> WorldDescription -> ShowS

show :: WorldDescription -> String

showList :: [WorldDescription] -> ShowS

Eq WorldDescription

Defined in Swarm.Game.Scenario

Methods

(==) :: WorldDescription -> WorldDescription -> Bool

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

Scenario

data Scenario

A Scenario contains all the information to describe a scenario.

Instances

Show Scenario

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> Scenario -> ShowS

show :: Scenario -> String

showList :: [Scenario] -> ShowS

Eq Scenario

Defined in Swarm.Game.Scenario

Methods

(==) :: Scenario -> Scenario -> Bool

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

FromJSONE EntityMap Scenario

Defined in Swarm.Game.Scenario

Methods

parseJSONE :: Value -> ParserE EntityMap Scenario

parseJSONE' :: EntityMap -> Value -> Parser Scenario

Fields

scenarioVersion :: Lens' Scenario Int

The version number of the scenario schema. Currently, this should always be 1, but it is ignored. In the future, this may be used to convert older formats to newer ones, or simply to print a nice error message when we can't read an older format.

scenarioName :: Lens' Scenario Text

The name of the scenario.

scenarioAuthor :: Lens' Scenario (Maybe Text)

The author of the scenario.

scenarioDescription :: Lens' Scenario Text

A high-level description of the scenario, shown e.g. in the menu.

scenarioCreative :: Lens' Scenario Bool

Whether the scenario should start in creative mode.

scenarioSeed :: Lens' Scenario (Maybe Int)

The seed used for the random number generator. If Nothing, use a random seed / prompt the user for the seed.

scenarioEntities :: Lens' Scenario EntityMap

Any custom entities used for this scenario.

scenarioRecipes :: Lens' Scenario [Recipe Entity]

Any custom recipes used in this scenario.

scenarioKnown :: Lens' Scenario [Text]

List of entities that should be considered "known", so robots do not have to scan them.

scenarioWorld :: Lens' Scenario WorldDescription

The starting world for the scenario.

scenarioRobots :: Lens' Scenario [TRobot]

The starting robots for the scenario. Note this should include the base.

scenarioObjectives :: Lens' Scenario [Objective]

A sequence of objectives for the scenario (if any).

scenarioSolution :: Lens' Scenario (Maybe ProcessedTerm)

An optional solution of the scenario, expressed as a program of type cmd a. This is useful for automated testing of the win condition.

scenarioStepsPerTick :: Lens' Scenario (Maybe Int)

Optionally, specify the maximum number of steps each robot may take during a single tick.

Loading from disk

loadScenario :: (Has (Lift IO) sig m, Has (Throw Text) sig m) => String -> EntityMap -> m (Scenario, FilePath)

Load a scenario with a given name from disk, given an entity map to use. This function is used if a specific scenario is requested on the command line.

loadScenarioFile :: (Has (Lift IO) sig m, Has (Throw Text) sig m) => EntityMap -> FilePath -> m Scenario

Load a scenario from a file.

getScenarioPath :: FilePath -> IO (Maybe FilePath)