From 318576dc04afe7be8cddedb42bee605d61f59742 Mon Sep 17 00:00:00 2001 From: florianf Date: Mon, 22 Feb 2010 07:10:29 +0000 Subject: [PATCH] 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 --- src/object/tilemap.hpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) 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; -- 2.11.0