src/object/candle.hpp

   1 //  SuperTux
   2 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.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_CANDLE_HPP
  18 #define HEADER_SUPERTUX_OBJECT_CANDLE_HPP
  19
  20 #include "object/moving_sprite.hpp"
  21 #include "supertux/script_interface.hpp"
  22
  23 /**
  24  * A burning candle: Simple, scriptable level decoration.
  25  */
  26 class Candle : public MovingSprite,
  27                public ScriptInterface
  28 {
  29 public:
  30   Candle(const Reader& lisp);
  31   virtual void draw(DrawingContext& context);
  32
  33   HitResponse collision(GameObject& other, const CollisionHit& hit);
  34
  35   virtual void expose(HSQUIRRELVM vm, SQInteger table_idx);
  36   virtual void unexpose(HSQUIRRELVM vm, SQInteger table_idx);
  37
  38   /**
  39    * @name Scriptable Methods
  40    * @{
  41    */
  42   void puff_smoke(); /**< spawn a puff of smoke */
  43   bool get_burning(); /**< returns true if candle is lighted */
  44   void set_burning(bool burning); /**< true: light candle, false: extinguish candle */
  45   /**
  46    * @}
  47    */
  48
  49 private:
  50   bool burning; /**< true if candle is currently lighted */
  51   bool flicker; /**< true if candle light is to flicker */
  52   Color lightcolor; /**< determines color or light given off */
  53   SpritePtr candle_light_1; /**< drawn to lightmap */
  54   SpritePtr candle_light_2; /**< drawn to lightmap (alternative image) */
  55
  56 };
  57
  58 #endif
  59
  60 /* EOF */