object/tilemap.hpp: Add an explanation to the boolean argument of ->get_movement().

git-svn-id: http://supertux.lethargik.org/svn/supertux/trunk/supertux@6388 837edb03-e0f3-0310-88ca-d4d4e8b29345

diff --git a/src/object/tilemap.hpp b/src/object/tilemap.hpp
index 28f9407..8b3939b 100644 (file)
--- a/src/object/tilemap.hpp
+++ b/src/object/tilemap.hpp
@@ -76,7 +76,10 @@ public:
   Vector get_offset() const
   { return offset; }
 
-  Vector get_movement(bool actual = false) const
+  /** Get the movement of this tilemap. The collision detection code may need a
+   *  non-negative y-movement. Passing `false' as the `actual' argument will
+   *  provide that. Used exclusively in src/supertux/sector.cpp. */
+  Vector get_movement(bool actual) const
   {
     if(actual) {
       return movement;