src/object/portable.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 #ifndef __PORTABLE_H__
  21 #define __PORTABLE_H__
  22
  23 #include "moving_object.hpp"
  24 #include "direction.hpp"
  25 #include "refcounter.hpp"
  26
  27 /**
  28  * An object that inherits from this object is considered "portable" and can
  29  * be carried around by the player.
  30  * The object has to additionally set the PORTABLE flag (this allows to
  31  * make the object only temporarily portable by resetting the flag)
  32  */
  33 class Portable
  34 {
  35 public:
  36   Portable(bool portable = false) :
  37     portable(portable)
  38   {
  39   }
  40   virtual ~Portable()
  41   { }
  42
  43   /**
  44    * called each frame when the object has been grabbed.
  45    */
  46   virtual void grab(MovingObject& object, const Vector& pos, Direction dir) = 0;
  47
  48   virtual void ungrab(MovingObject& , Direction )
  49   {}
  50
  51   // --- BEGIN METHODS TO EXPOSE TO SQUIRREL --- //
  52   void set_portable(bool portable)
  53   {
  54     this->portable = portable;
  55   }
  56
  57   bool is_portable() const
  58   {
  59     return portable;
  60   }
  61   // --- END METHODS TO EXPOSE TO SQUIRREL --- //
  62
  63 private:
  64   bool portable; /**< true if this object can currently be carried */
  65 };
  66
  67 #endif