Swarm.Game.Scenario.Topography.Structure

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

Documentation

data NamedArea a

Constructors

NamedArea

Fields

• name :: StructureName
• recognize :: Set AbsoluteDir

  whether this structure should be registered for automatic recognition and which orientations shall be recognized. The supplied direction indicates which cardinal direction the original map's North has been re-oriented to. E.g., DWest represents a rotation of 90 degrees counter-clockwise.

• description :: Maybe Text

  will be UI-facing only if this is a recognizable structure

• structure :: a

Instances

Functor NamedArea

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

fmap :: (a -> b) -> NamedArea a -> NamedArea b

(<$) :: a -> NamedArea b -> NamedArea a

FromJSONE e a => FromJSONE e (NamedStructure (Maybe a))

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

parseJSONE :: Value -> ParserE e (NamedStructure (Maybe a))

parseJSONE' :: e -> Value -> Parser (NamedStructure (Maybe a))

Show a => Show (NamedArea a)

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

showsPrec :: Int -> NamedArea a -> ShowS

show :: NamedArea a -> String

showList :: [NamedArea a] -> ShowS

Eq a => Eq (NamedArea a)

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

(==) :: NamedArea a -> NamedArea a -> Bool

(/=) :: NamedArea a -> NamedArea a -> Bool

isRecognizable :: NamedArea a -> Bool

type NamedGrid c = NamedArea (Grid c)

type NamedStructure c = NamedArea (PStructure c)

data PStructure c

Constructors

Structure

Fields

• area :: PositionedGrid 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

FromJSONE e a => FromJSONE e (NamedStructure (Maybe a))

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

parseJSONE :: Value -> ParserE e (NamedStructure (Maybe a))

parseJSONE' :: e -> Value -> Parser (NamedStructure (Maybe a))

FromJSONE e a => FromJSONE e (PStructure (Maybe a))

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

parseJSONE :: Value -> ParserE e (PStructure (Maybe a))

parseJSONE' :: e -> Value -> Parser (PStructure (Maybe a))

Show (PStructure c)

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)

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

(==) :: PStructure c -> PStructure c -> Bool

(/=) :: PStructure c -> PStructure c -> Bool

data Placed c

Constructors

Placed Placement (NamedStructure c)

Instances

Show (Placed c)

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

showsPrec :: Int -> Placed c -> ShowS

show :: Placed c -> String

showList :: [Placed c] -> ShowS

data LocatedStructure

For use in registering recognizable pre-placed structures

Constructors

LocatedStructure

Fields

• placedName :: StructureName
• upDirection :: AbsoluteDir
• cornerLoc :: Location

Instances

Show LocatedStructure

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

showsPrec :: Int -> LocatedStructure -> ShowS

show :: LocatedStructure -> String

showList :: [LocatedStructure] -> ShowS

HasLocation LocatedStructure

Defined in Swarm.Game.Scenario.Topography.Structure

Methods

modifyLoc :: (Location -> Location) -> LocatedStructure -> LocatedStructure

offsetLoc :: V2 Int32 -> LocatedStructure -> LocatedStructure

data MergedStructure c

Constructors

MergedStructure (PositionedGrid c) [LocatedStructure] [Originated Waypoint]

paintMap :: MonadFail m => Maybe Char -> StructurePalette c -> Grid Char -> m (Grid (Maybe c), [Waypoint])

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

Orphan instances

FromJSON (Grid Char)

Methods

parseJSON :: Value -> Parser (Grid Char)

parseJSONList :: Value -> Parser [Grid Char]

omittedField :: Maybe (Grid Char)