Comments

app/Main.hs

@@ -48,6 +48,7 @@ import qualified Config as Co
 
 import Utils
 
+-- Warning : Config is hardcoded
 loadConfig :: IO Configuration
 loadConfig = return (Co.Config { Co.screenW = 1024, Co.screenH = 531})
 
@@ -76,6 +77,8 @@ banner = do
   putStrLn "You can now enter a custom name (Default is 'Fighter 1/2')"
   putStrLn "Let's go and be careful! ;)"
 
+-- | Get fighter asset id by fighter id and fighter action
+--  (4 actions, 2 fighters = 8 images)
 fighterAssetId :: Integer -> G.FighterAction -> String
 fighterAssetId 1 G.None = "fighter1"
 fighterAssetId 1 G.Kick = "fighter1K"
@@ -86,10 +89,12 @@ fighterAssetId 2 G.Kick = "fighter2K"
 fighterAssetId 2 G.Jump = "fighter2J"
 fighterAssetId 2 G.Protect = "fighter2P"
 
+-- Warning : images gap are hardcoded
 fighter2AssetPosX :: G.FighterAction -> Integer
 fighter2AssetPosX G.Kick = 30   -- (= 110-80)
 fighter2AssetPosX _ = 0
 
+-- Warning : images gap are hardcoded
 fighterAssetPosY :: G.FighterAction -> Integer
 fighterAssetPosY G.Jump = 135   -- (Jump image height)
 fighterAssetPosY _ = 0

src/Coord.hs

@@ -45,6 +45,7 @@ prop_move_leftRight (Coord x y) i = move (move (Coord x y) (Mov R i)) (Mov L i)
 prop_move_upDown :: Coordinates -> Integer -> Bool
 prop_move_upDown (Coord x y) i = move (move (Coord x y) (Mov U i)) (Mov D i) == (Coord x y)
 
+-- if out of zone after movement, do not move!
 moveSafe :: Zone -> Coordinates -> Movement -> Coordinates
 moveSafe (Zone _ h) (Coord x y) (Mov U u)
     | y+u <= h = move (Coord x y) (Mov U u)
@@ -59,7 +60,7 @@ moveSafe (Zone w _) (Coord x y) (Mov L l)
     | x-l >= 0 = move (Coord x y) (Mov L l)
     | otherwise = Coord x y
 
--- Int nb mvt > 0
+-- Int nb mvt must be positive
 prop_inv_movement :: Movement -> Bool
 prop_inv_movement (Mov _ n) = n>=0