fix haddock markup
This commit is contained in:
parent
1eae6ae381
commit
e4bd5198e0
|
@ -36,7 +36,7 @@ constructMap desc tilemapSlot = do
|
||||||
<*> pure (V2 (fst $ levelStartPos desc) (snd $ levelStartPos desc))
|
<*> pure (V2 (fst $ levelStartPos desc) (snd $ levelStartPos desc))
|
||||||
|
|
||||||
readLayer
|
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)
|
-> IO (MapLayer, V2 Int)
|
||||||
readLayer (idx, path) = do
|
readLayer (idx, path) = do
|
||||||
img <- either error convertRGBA8 <$> readImage path
|
img <- either error convertRGBA8 <$> readImage path
|
||||||
|
|
|
@ -9,22 +9,22 @@ import Linear
|
||||||
import Types.Texture
|
import Types.Texture
|
||||||
|
|
||||||
data LevelMap = LevelMap
|
data LevelMap = LevelMap
|
||||||
{ mapLayers :: Vector MapLayer -- ^ Layer stack
|
{ mapLayers :: Vector MapLayer -- | Layer stack
|
||||||
, mapWalkLayer :: Word -- ^ Collision layer index in stack
|
, mapWalkLayer :: Word -- | Collision layer index in stack
|
||||||
, mapDimensions :: V2 Word -- ^ Dimension of map in tiles
|
, mapDimensions :: V2 Word -- | Dimension of map in tiles
|
||||||
, mapTileMap :: TileMap -- ^ The tile map
|
, mapTileMap :: TileMap -- | The tile map
|
||||||
, mapStartPos :: V2 Word -- ^ Player start position
|
, mapStartPos :: V2 Word -- | Player start position
|
||||||
}
|
}
|
||||||
deriving (Eq, Show)
|
deriving (Eq, Show)
|
||||||
|
|
||||||
newtype MapLayer = MapLayer
|
newtype MapLayer = MapLayer
|
||||||
{ layerTiles :: Vector Tile -- ^ Tiles of this layer
|
{ layerTiles :: Vector Tile -- | Tiles of this layer
|
||||||
}
|
}
|
||||||
deriving (Eq, Show)
|
deriving (Eq, Show)
|
||||||
|
|
||||||
data Tile = Tile
|
data Tile = Tile
|
||||||
{ tileOffset :: V2 Word -- ^ Offset of this tile on the tile map
|
{ tileOffset :: V2 Word -- | Offset of this tile on the tile map
|
||||||
, tileType :: TileType -- ^ Type of tile
|
, tileType :: TileType -- | Type of tile
|
||||||
}
|
}
|
||||||
deriving (Eq, Show)
|
deriving (Eq, Show)
|
||||||
|
|
||||||
|
@ -35,16 +35,16 @@ data TileType
|
||||||
deriving (Enum, Ord, Eq, Show)
|
deriving (Enum, Ord, Eq, Show)
|
||||||
|
|
||||||
data TileMap = TileMap
|
data TileMap = TileMap
|
||||||
{ tileMapDimensions :: V2 Word -- ^ Dimensions of tile map image in pixels
|
{ tileMapDimensions :: V2 Word -- | Dimensions of tile map image in pixels
|
||||||
, tileMapTexture :: Texture -- ^ Texture object on GPU
|
, tileMapTexture :: Texture -- | Texture object on GPU
|
||||||
}
|
}
|
||||||
deriving (Eq, Show)
|
deriving (Eq, Show)
|
||||||
|
|
||||||
data LevelDescriptor = LevelDescriptor
|
data LevelDescriptor = LevelDescriptor
|
||||||
{ levelLayerPath :: [(Word, FilePath)] -- ^ Indexed paths to the layers
|
{ levelLayerPath :: [(Word, FilePath)] -- | Indexed paths to the layers
|
||||||
, levelWalkLayer :: Word -- ^ Index of walk layer
|
, levelWalkLayer :: Word -- | Index of walk layer
|
||||||
, levelTileMap :: FilePath -- ^ Filepath to tile map
|
, levelTileMap :: FilePath -- | Filepath to tile map
|
||||||
, levelStartPos :: (Word, Word) -- ^ Player start position
|
, levelStartPos :: (Word, Word) -- | Player start position
|
||||||
-- , levelCollectibles :: [(V2 Word, ())] -- | TODO; Collectibles and their tile coords
|
-- , levelCollectibles :: [(V2 Word, ())] -- | TODO; Collectibles and their tile coords
|
||||||
-- , levelEnemies :: [(V2 Word, ())] -- | TODO: Enemies and their tile coords
|
-- , levelEnemies :: [(V2 Word, ())] -- | TODO: Enemies and their tile coords
|
||||||
-- , levelInteractables :: [(V2 Word, ())] -- | TODO: Interactables and their coords
|
-- , levelInteractables :: [(V2 Word, ())] -- | TODO: Interactables and their coords
|
||||||
|
|
Loading…
Reference in a new issue