src/object/portable.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_OBJECT_PORTABLE_HPP
  18 #define HEADER_SUPERTUX_OBJECT_PORTABLE_HPP
  19
  20 #include "supertux/direction.hpp"
  21 #include "supertux/moving_object.hpp"
  22
  23 /**
  24  * An object that inherits from this object is considered "portable" and can
  25  * be carried around by the player.
  26  * The object has to additionally set the PORTABLE flag (this allows to
  27  * make the object only temporarily portable by resetting the flag)
  28  */
  29 class Portable
  30 {
  31 public:
  32   virtual ~Portable()
  33   { }
  34
  35   /**
  36    * called each frame when the object has been grabbed.
  37    */
  38   virtual void grab(MovingObject& object, const Vector& pos, Direction dir) = 0;
  39
  40   virtual void ungrab(MovingObject& , Direction )
  41   {}
  42
  43   virtual bool is_portable() const
  44   {
  45     return true;
  46   }
  47
  48   /**
  49    * Is the object so heavy/bulky/fragile that Tux can't run while
  50    * carrying it?
  51    */
  52   virtual bool is_hampering()
  53   {
  54     return false;
  55   }
  56 };
  57
  58 #endif
  59
  60 /* EOF */