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 :: Erasable e
• cellRobots :: [IndexedTRobot]

Instances

ToJSON Cell

Defined in Swarm.Game.Scenario.Topography.Cell

Methods

toJSON :: Cell -> Value

toEncoding :: Cell -> Encoding

toJSONList :: [Cell] -> Value

toEncodingList :: [Cell] -> Encoding

omitField :: Cell -> Bool

ToJSON CellPaintDisplay

Defined in Swarm.Game.Scenario.Topography.Cell

Methods

toJSON :: CellPaintDisplay -> Value

toEncoding :: CellPaintDisplay -> Encoding

toJSONList :: [CellPaintDisplay] -> Value

toEncodingList :: [CellPaintDisplay] -> Encoding

omitField :: CellPaintDisplay -> Bool

Show e => Show (PCell e)

Defined in Swarm.Game.Scenario.Topography.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.Topography.Cell

Methods

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

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

FromJSONE (TerrainEntityMaps, 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.Topography.Cell

Methods

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

parseJSONE' :: (TerrainEntityMaps, 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

• offsetOrigin :: Bool
• scrollable :: Bool
• palette :: WorldPalette e
• ul :: Location
• area :: PositionedGrid (Maybe (PCell e))
• navigation :: Navigation Identity WaypointName
• placedStructures :: [LocatedStructure]
• worldName :: SubworldName
• worldProg :: Maybe (TTerm '[] (World CellVal))

Instances

ToJSON WorldDescriptionPaint

Defined in Swarm.Game.Scenario.Topography.WorldDescription

Methods

toJSON :: WorldDescriptionPaint -> Value

toEncoding :: WorldDescriptionPaint -> Encoding

toJSONList :: [WorldDescriptionPaint] -> Value

toEncodingList :: [WorldDescriptionPaint] -> Encoding

omitField :: WorldDescriptionPaint -> Bool

FromJSONE WorldParseDependencies WorldDescription

Defined in Swarm.Game.Scenario.Topography.WorldDescription

Methods

parseJSONE :: Value -> ParserE WorldParseDependencies WorldDescription

parseJSONE' :: WorldParseDependencies -> Value -> Parser WorldDescription

Show e => Show (PWorldDescription e)

Defined in Swarm.Game.Scenario.Topography.WorldDescription

Methods

showsPrec :: Int -> PWorldDescription e -> ShowS

show :: PWorldDescription e -> String

showList :: [PWorldDescription e] -> ShowS

type WorldDescription = PWorldDescription Entity

type IndexedTRobot = (Int, TRobot)

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

type StructureCells = NamedGrid (Maybe Cell)

Scenario

data Scenario

A Scenario contains all the information to describe a scenario.

Constructors

Scenario

Fields

• _scenarioMetadata :: ScenarioMetadata
• _scenarioOperation :: ScenarioOperation
• _scenarioLandscape :: ScenarioLandscape

Instances

Show Scenario

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> Scenario -> ShowS

show :: Scenario -> String

showList :: [Scenario] -> ShowS

FromJSONE ScenarioInputs Scenario

Defined in Swarm.Game.Scenario

Methods

parseJSONE :: Value -> ParserE ScenarioInputs Scenario

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

data ScenarioLandscape

All cosmetic and structural content of the scenario.

Constructors

ScenarioLandscape

Fields

• _scenarioSeed :: Maybe Int
• _scenarioAttrs :: [CustomAttr]
• _scenarioTerrainAndEntities :: TerrainEntityMaps
• _scenarioCosmetics :: Map WorldAttr PreservableColor
• _scenarioKnown :: Set EntityName
• _scenarioWorlds :: NonEmpty WorldDescription
• _scenarioNavigation :: Navigation (Map SubworldName) Location
• _scenarioStructures :: StaticStructureInfo
• _scenarioRobots :: [TRobot]

Instances

Show ScenarioLandscape

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> ScenarioLandscape -> ShowS

show :: ScenarioLandscape -> String

showList :: [ScenarioLandscape] -> ShowS

data StaticStructureInfo

Constructors

StaticStructureInfo

Fields

• _structureDefs :: [SymmetryAnnotatedGrid StructureCells]
• _staticPlacements :: Map SubworldName [LocatedStructure]

Instances

Show StaticStructureInfo

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> StaticStructureInfo -> ShowS

show :: StaticStructureInfo -> String

showList :: [StaticStructureInfo] -> ShowS

data ScenarioMetadata

Authorship information about scenario not used at play-time

Constructors

ScenarioMetadata Int Text (Maybe Text)

Instances

ToJSON ScenarioMetadata

Defined in Swarm.Game.Scenario

Methods

toJSON :: ScenarioMetadata -> Value

toEncoding :: ScenarioMetadata -> Encoding

toJSONList :: [ScenarioMetadata] -> Value

toEncodingList :: [ScenarioMetadata] -> Encoding

omitField :: ScenarioMetadata -> Bool

Generic ScenarioMetadata

Defined in Swarm.Game.Scenario

Associated Types

type Rep ScenarioMetadata :: Type -> Type

Methods

from :: ScenarioMetadata -> Rep ScenarioMetadata x

to :: Rep ScenarioMetadata x -> ScenarioMetadata

Show ScenarioMetadata

Defined in Swarm.Game.Scenario

Methods

showsPrec :: Int -> ScenarioMetadata -> ShowS

show :: ScenarioMetadata -> String

showList :: [ScenarioMetadata] -> ShowS

type Rep ScenarioMetadata

Defined in Swarm.Game.Scenario

type Rep ScenarioMetadata = D1 ('MetaData "ScenarioMetadata" "Swarm.Game.Scenario" "swarm-0.6.0.0-ERx1HMcRMba59aI2b6aNrS-swarm-scenario" 'False) (C1 ('MetaCons "ScenarioMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "_scenarioVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "_scenarioName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_scenarioAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

staticPlacements :: Lens' StaticStructureInfo (Map SubworldName [LocatedStructure])

A record of the static placements of structures, so that they can be added to the "recognized" list upon scenario initialization

structureDefs :: Lens' StaticStructureInfo [SymmetryAnnotatedGrid StructureCells]

Structure templates that may be auto-recognized when constructed by a robot

Fields

scenarioMetadata :: Lens' Scenario ScenarioMetadata

Authorship information about scenario not used at play-time

scenarioOperation :: Lens' Scenario ScenarioOperation

Non-structural gameplay content of the scenario; how it is to be played.

scenarioLandscape :: Lens' Scenario ScenarioLandscape

All cosmetic and structural content of the scenario.

scenarioVersion :: Lens' ScenarioMetadata 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' ScenarioMetadata Text

The name of the scenario.

scenarioAuthor :: Lens' ScenarioMetadata (Maybe Text)

The author of the scenario.

scenarioDescription :: Lens' ScenarioOperation (Document Syntax)

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

scenarioCreative :: Lens' ScenarioOperation Bool

Whether the scenario should start in creative mode.

scenarioSeed :: Lens' ScenarioLandscape (Maybe Int)

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

scenarioAttrs :: Lens' ScenarioLandscape [CustomAttr]

Custom attributes defined in the scenario.

scenarioTerrainAndEntities :: Lens' ScenarioLandscape TerrainEntityMaps

Any custom terrain and entities used for this scenario, combined with the default system terrain and entities.

scenarioCosmetics :: Lens' ScenarioLandscape (Map WorldAttr PreservableColor)

High-fidelity color map for entities

scenarioRecipes :: Lens' ScenarioOperation [Recipe Entity]

Any custom recipes used in this scenario.

scenarioKnown :: Lens' ScenarioLandscape (Set EntityName)

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

scenarioWorlds :: Lens' ScenarioLandscape (NonEmpty WorldDescription)

The subworlds of the scenario. The "root" subworld shall always be at the head of the list, by construction.

scenarioNavigation :: Lens' ScenarioLandscape (Navigation (Map SubworldName) Location)

Waypoints and inter-world portals

scenarioStructures :: Lens' ScenarioLandscape StaticStructureInfo

Information required for structure recognition

scenarioRobots :: Lens' ScenarioLandscape [TRobot]

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

scenarioObjectives :: Lens' ScenarioOperation [Objective]

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

scenarioSolution :: Lens' ScenarioOperation (Maybe TSyntax)

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' ScenarioOperation (Maybe Int)

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

Loading from disk

loadScenario :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => FilePath -> ScenarioInputs -> 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 (Throw SystemFailure) sig m, Has (Lift IO) sig m) => ScenarioInputs -> FilePath -> m Scenario

Load a scenario from a file.

getScenarioPath :: Has (Lift IO) sig m => FilePath -> m (Maybe FilePath)

loadStandaloneScenario :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => FilePath -> m (Scenario, GameStateInputs)

data GameStateInputs

Constructors

GameStateInputs

Fields

• gsiScenarioInputs :: ScenarioInputs
• gsiRecipes :: [Recipe Entity]

  The standard list of recipes loaded from disk. Individual scenarios may define additional recipes which will get added to this list when loading the scenario.

data ScenarioInputs

Constructors

ScenarioInputs

Fields

• initWorldMap :: WorldMap

  A collection of typechecked world DSL terms that are available to be used in scenario definitions.

• initEntityTerrain :: TerrainEntityMaps

  The standard terrain/entity maps loaded from disk. Individual scenarios may define additional terrain/entities which will get added to this map when loading the scenario.

Instances

FromJSONE ScenarioInputs Scenario

Defined in Swarm.Game.Scenario

Methods

parseJSONE :: Value -> ParserE ScenarioInputs Scenario

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

Utilities

arbitrateSeed :: Maybe Seed -> ScenarioLandscape -> IO Seed

Decide on a seed. In order of preference, we will use: 1. seed value provided by the user 2. seed value specified in the scenario description 3. randomly chosen seed value