src/object/candle.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.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 __CANDLE_H__
  21 #define __CANDLE_H__
  22
  23 #include <string>
  24
  25 #include "lisp/lisp.hpp"
  26 #include "object/moving_sprite.hpp"
  27 #include "script_interface.hpp"
  28
  29 /**
  30  * A burning candle: Simple, scriptable level decoration.
  31  */
  32 class Candle : public MovingSprite, public ScriptInterface
  33 {
  34 public:
  35   Candle(const lisp::Lisp& lisp);
  36   virtual Candle* clone() const { return new Candle(*this); }
  37
  38   HitResponse collision(GameObject& other, const CollisionHit& hit);
  39
  40   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
  41   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  42
  43   void puff_smoke(); /**< spawn a puff of smoke */
  44
  45   bool get_burning(); /**< returns true if candle is lighted */
  46   void set_burning(bool burning); /**< true: light candle, false: extinguish candle */
  47
  48 private:
  49   bool burning; /**< true if candle is currently lighted */
  50   std::string name; /**< user-defined name for use in scripts or empty string if not scriptable */
  51
  52 };
  53
  54 #endif