License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Game.Scenario.Topography.Structure

Description

Definitions of "structures" for use within a map, as well as logic for combining them.

Synopsis

data NamedStructure c = NamedStructure {
- name :: StructureName
- structure :: PStructure c
}
type InheritedStructureDefs = [NamedStructure (Maybe (PCell Entity))]
data PStructure c = Structure {
- area :: [[c]]
- structures :: [NamedStructure c]
- placements :: [Placement]
- waypoints :: [Waypoint]
}
data MergedStructure c = MergedStructure [[c]] [Originated Waypoint]
overlaySingleStructure :: Map StructureName (PStructure (Maybe a)) -> (Placement, PStructure (Maybe a)) -> MergedStructure (Maybe a) -> MergedStructure (Maybe a)
mergeStructures :: Map StructureName (PStructure (Maybe a)) -> Maybe Placement -> PStructure (Maybe a) -> MergedStructure (Maybe a)
paintMap :: MonadFail m => Maybe Char -> WorldPalette e -> Text -> m ([[Maybe (PCell e)]], [Waypoint])
readMap :: Applicative f => (Char -> f b) -> Text -> f [[b]]

Documentation

data NamedStructure c Source #

Constructors

NamedStructure
Fields name :: StructureName structure :: PStructure c

Instances

Instances details

Show c => Show (NamedStructure c) Source #
Instance details Defined in Swarm.Game.Scenario.Topography.Structure Methods showsPrec :: Int -> NamedStructure c -> ShowS # show :: NamedStructure c -> String # showList :: [NamedStructure c] -> ShowS #
Eq c => Eq (NamedStructure c) Source #
Instance details Defined in Swarm.Game.Scenario.Topography.Structure Methods (==) :: NamedStructure c -> NamedStructure c -> Bool # (/=) :: NamedStructure c -> NamedStructure c -> Bool #
FromJSONE (EntityMap, RobotMap) (NamedStructure (Maybe (PCell Entity))) Source #
Instance details Defined in Swarm.Game.Scenario.Topography.Structure Methods parseJSONE :: Value -> ParserE (EntityMap, RobotMap) (NamedStructure (Maybe (PCell Entity))) Source # parseJSONE' :: (EntityMap, RobotMap) -> Value -> Parser (NamedStructure (Maybe (PCell Entity))) Source #
FromJSONE (WorldMap, InheritedStructureDefs, EntityMap, RobotMap) WorldDescription Source #
Instance details Defined in Swarm.Game.Scenario.Topography.WorldDescription Methods parseJSONE :: Value -> ParserE (WorldMap, InheritedStructureDefs, EntityMap, RobotMap) WorldDescription Source # parseJSONE' :: (WorldMap, InheritedStructureDefs, EntityMap, RobotMap) -> Value -> Parser WorldDescription Source #

type InheritedStructureDefs = [NamedStructure (Maybe (PCell Entity))] Source #

data PStructure c Source #

Constructors

Structure
Fields area :: [[c]] structures :: [NamedStructure c] structure definitions from parents shall be accessible by children placements :: [Placement] earlier placements will be overlaid on top of later placements in the YAML file waypoints :: [Waypoint]

Instances

Instances details

Show c => Show (PStructure c) Source #
Instance details Defined in Swarm.Game.Scenario.Topography.Structure Methods showsPrec :: Int -> PStructure c -> ShowS # show :: PStructure c -> String # showList :: [PStructure c] -> ShowS #
Eq c => Eq (PStructure c) Source #
Instance details Defined in Swarm.Game.Scenario.Topography.Structure Methods (==) :: PStructure c -> PStructure c -> Bool # (/=) :: PStructure c -> PStructure c -> Bool #
FromJSONE (EntityMap, RobotMap) (PStructure (Maybe (PCell Entity))) Source #
Instance details Defined in Swarm.Game.Scenario.Topography.Structure Methods parseJSONE :: Value -> ParserE (EntityMap, RobotMap) (PStructure (Maybe (PCell Entity))) Source # parseJSONE' :: (EntityMap, RobotMap) -> Value -> Parser (PStructure (Maybe (PCell Entity))) Source #

data MergedStructure c Source #

Constructors

MergedStructure [[c]] [Originated Waypoint]

overlaySingleStructure :: Map StructureName (PStructure (Maybe a)) -> (Placement, PStructure (Maybe a)) -> MergedStructure (Maybe a) -> MergedStructure (Maybe a) Source #

Destructively overlays one direct child structure upon the input structure. However, the child structure is assembled recursively.

mergeStructures :: Map StructureName (PStructure (Maybe a)) -> Maybe Placement -> PStructure (Maybe a) -> MergedStructure (Maybe a) Source #

Overlays all of the "child placements", such that the children encountered earlier in the YAML file supersede the later ones (due to use of foldr instead of foldl).

paintMap :: MonadFail m => Maybe Char -> WorldPalette e -> Text -> m ([[Maybe (PCell e)]], [Waypoint]) Source #

"Paint" a world map using a WorldPalette, turning it from a raw string into a nested list of PCell values by looking up each character in the palette, failing if any character in the raw map is not contained in the palette.

readMap :: Applicative f => (Char -> f b) -> Text -> f [[b]] Source #