fix haddock markup

This commit is contained in:
nek0 2020-12-07 16:03:16 +01:00
parent 7142ce9b55
commit 1eae6ae381
2 changed files with 15 additions and 15 deletions

View File

@ -36,7 +36,7 @@ constructMap desc tilemapSlot = do
<*> pure (V2 (fst $ levelStartPos desc) (snd $ levelStartPos desc))
readLayer
:: (Word, FilePath) -- | index and path of the layer descriptor image
:: (Word, FilePath) -- ^ index and path of the layer descriptor image
-> IO (MapLayer, V2 Int)
readLayer (idx, path) = do
img <- either error convertRGBA8 <$> readImage path

View File

@ -9,22 +9,22 @@ import Linear
import Types.Texture
data LevelMap = LevelMap
{ mapLayers :: Vector MapLayer -- | Layer stack
, mapWalkLayer :: Word -- | Collision layer index in stack
, mapDimensions :: V2 Word -- | Dimension of map in tiles
, mapTileMap :: TileMap -- | The tile map
, mapStartPos :: V2 Word -- | Player start position
{ mapLayers :: Vector MapLayer -- ^ Layer stack
, mapWalkLayer :: Word -- ^ Collision layer index in stack
, mapDimensions :: V2 Word -- ^ Dimension of map in tiles
, mapTileMap :: TileMap -- ^ The tile map
, mapStartPos :: V2 Word -- ^ Player start position
}
deriving (Eq, Show)
newtype MapLayer = MapLayer
{ layerTiles :: Vector Tile -- | Tiles of this layer
{ layerTiles :: Vector Tile -- ^ Tiles of this layer
}
deriving (Eq, Show)
data Tile = Tile
{ tileOffset :: V2 Word -- | Offset of this tile on the tile map
, tileType :: TileType -- | Type of tile
{ tileOffset :: V2 Word -- ^ Offset of this tile on the tile map
, tileType :: TileType -- ^ Type of tile
}
deriving (Eq, Show)
@ -35,16 +35,16 @@ data TileType
deriving (Enum, Ord, Eq, Show)
data TileMap = TileMap
{ tileMapDimensions :: V2 Word -- | Dimensions of tile map image in pixels
, tileMapTexture :: Texture -- | Texture object on GPU
{ tileMapDimensions :: V2 Word -- ^ Dimensions of tile map image in pixels
, tileMapTexture :: Texture -- ^ Texture object on GPU
}
deriving (Eq, Show)
data LevelDescriptor = LevelDescriptor
{ levelLayerPath :: [(Word, FilePath)] -- | Indexed paths to the layers
, levelWalkLayer :: Word -- | Index of walk layer
, levelTileMap :: FilePath -- | Filepath to tile map
, levelStartPos :: (Word, Word) -- | Player start position
{ levelLayerPath :: [(Word, FilePath)] -- ^ Indexed paths to the layers
, levelWalkLayer :: Word -- ^ Index of walk layer
, levelTileMap :: FilePath -- ^ Filepath to tile map
, levelStartPos :: (Word, Word) -- ^ Player start position
-- , levelCollectibles :: [(V2 Word, ())] -- | TODO; Collectibles and their tile coords
-- , levelEnemies :: [(V2 Word, ())] -- | TODO: Enemies and their tile coords
-- , levelInteractables :: [(V2 Word, ())] -- | TODO: Interactables and their coords