src/scripting/sound.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 __SOUND_H__
  21 #define __SOUND_H__
  22
  23 namespace Scripting
  24 {
  25
  26 /**
  27  * This class allows manipulating the sound output of the game
  28  */
  29 class Sound
  30 {
  31 public:
  32   void play_music(const std::string& musicfile);
  33   /**
  34    * Play a sound effect. The name should be without path or .wav extension
  35    */
  36   void play(const std::string& soundfile);
  37
  38   ~Sound();
  39
  40 #ifndef SCRIPTING_API
  41   Sound();
  42 #endif
  43 };
  44
  45 }
  46
  47 #endif
  48