Hlinting

src/Dodge/WorldEvent/ThingsHit.hs

@@ -1,19 +1,27 @@
+{-
+Find which objects lie upon a line.
+ -}
 module Dodge.WorldEvent.ThingsHit
     where
 import Dodge.Data
 import Dodge.Base
-
 import Geometry
 
 import qualified Data.IntMap.Strict as IM
 import Data.List
 import Data.Maybe
 import Data.Function (on)
-
-thingsHit :: Point2 -> Point2 -> World -> [(Point2, Either3 Creature Wall ForceField)]
+{-
+List those objects that appear on a line.
+-}
+thingsHit 
+    :: Point2    -- ^ Line start point
+    -> Point2    -- ^ Line end point
+    -> World 
+    -> [(Point2, Either3 Creature Wall ForceField)]
 thingsHit sp ep w 
     | sp == ep  = []
-    | otherwise = sortBy (compare `on` dist sp . fst) (crs ++  walls ++ ffs)
+    | otherwise = sortBy (compare `on` dist sp . fst) (crs ++ walls ++ ffs)
   where 
     hitCrs   = IM.elems $ IM.filter (\cr -> circOnSeg sp ep (_crPos cr) (_crRad cr))
                                       $ _creatures w
@@ -31,9 +39,16 @@ thingsHit sp ep w
     hitFFs   = mapMaybe (collidePointFF sp ep (_randGen w)) (IM.elems $ _forceFields w)
     ffs = map (\(p,(_,i)) -> (p, E3x3 $ _forceFields w IM.! i)) hitFFs
 
-
-thingsHitExceptCr :: Maybe Int -> Point2 -> Point2 -> World 
-                        -> [(Point2, (Either3 Creature Wall ForceField))]
+{-
+List objects that appear on a line.
+Can filter out a creature.
+-}
+thingsHitExceptCr 
+    :: Maybe Int -- ^ A possible creature ID
+    -> Point2    -- ^ Line start point
+    -> Point2    -- ^ Line end point
+    -> World 
+    -> [(Point2, Either3 Creature Wall ForceField)]
 thingsHitExceptCr Nothing    sp ep = thingsHit sp ep
 thingsHitExceptCr (Just cid) sp ep = filter crNotCid . thingsHit sp ep
   where