From: Florian Forster <supertux@octo.it>
Date: Mon, 22 Feb 2010 07:10:29 +0000 (+0000)
Subject: object/tilemap.hpp: Add an explanation to the boolean argument of ->get_movement().
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=c3777d70e689698b869965a196b83cb5067f7292;p=supertux.git

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

SVN-Revision: 6388
---

diff --git a/src/object/tilemap.hpp b/src/object/tilemap.hpp
index 28f9407d4..8b3939bf2 100644
--- 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;