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.

WorldDescription

data PCell e

A single cell in a world map, which contains a terrain value, and optionally an entity and robot. It is parameterized on the Entity type to facilitate less stateful versions of the Entity type in rendering scenario data.

Constructors

Cell

Fields

• cellTerrain :: TerrainType
• cellEntity :: Maybe e
• cellRobots :: [IndexedTRobot]

Instances

Show e => Show (PCell e)

Defined in Swarm.Game.Scenario.Cell

Methods

showsPrec :: Int -> PCell e -> ShowS

show :: PCell e -> String

showList :: [PCell e] -> ShowS

Eq e => Eq (PCell e)

Defined in Swarm.Game.Scenario.Cell

Methods

(==) :: PCell e -> PCell e -> Bool

(/=) :: PCell e -> PCell e -> Bool

FromJSONE (EntityMap, RobotMap) Cell

Parse a tuple such as [grass, rock, base] into a PCell. The entity and robot, if present, are immediately looked up and converted into Entity and TRobot values. If they are not found, a parse error results.

Defined in Swarm.Game.Scenario.Cell

Methods

parseJSONE :: Value -> ParserE (EntityMap, RobotMap) Cell

parseJSONE' :: (EntityMap, RobotMap) -> Value -> Parser Cell

type Cell = PCell Entity

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

data PWorldDescription e

A description of a world parsed from a YAML file. This type is parameterized to accommodate Cells that utilize a less stateful Entity type.

Constructors

WorldDescription

Fields

• defaultTerrain :: Maybe (PCell e)
• offsetOrigin :: Bool
• palette :: WorldPalette e
• ul :: Location
• area :: [[PCell e]]

Instances

Show e => Show (PWorldDescription e)

Defined in Swarm.Game.Scenario.WorldDescription

Methods

showsPrec :: Int -> PWorldDescription e -> ShowS

show :: PWorldDescription e -> String

showList :: [PWorldDescription e] -> ShowS

Eq e => Eq (PWorldDescription e)

Defined in Swarm.Game.Scenario.WorldDescription

Methods

(==) :: PWorldDescription e -> PWorldDescription e -> Bool

(/=) :: PWorldDescription e -> PWorldDescription e -> Bool

FromJSONE (EntityMap, RobotMap) WorldDescription

Defined in Swarm.Game.Scenario.WorldDescription

Methods

parseJSONE :: Value -> ParserE (EntityMap, RobotMap) WorldDescription

parseJSONE' :: (EntityMap, RobotMap) -> Value -> Parser WorldDescription

type WorldDescription = PWorldDescription Entity

type IndexedTRobot = (Int, TRobot)

A robot template paired with its definition's index within the Scenario file

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.

scenarioAttrs :: Lens' Scenario [CustomAttr]

Custom attributes defined in the scenario.

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)