pause.h

Go to the documentation of this file.

//            Copyright (C) 2004-2007 by The Allacrost Project
//                         All Rights Reserved
//
// This code is licensed under the GNU GPL version 2. It is free software 
// and you may modify it and/or redistribute it under the terms of this license.
// See http://www.gnu.org/copyleft/gpl.html for details.

#ifndef __PAUSE_HEADER__
#define __PAUSE_HEADER__

#include "utils.h"
#include "defs.h"
#include "mode_manager.h"
#include "video.h"

namespace hoa_pause {

extern bool PAUSE_DEBUG;

/*!****************************************************************************
 * \brief A mode pushed onto the game mode stack when the user pauses the game.
 *
 * This class basically saves the last frame displayed to the screen, grays it
 * out a little, and then renders the text "Paused" in the center of the screen.
 * The game remains paused until the user either presses the pause button again
 * or tries to quit the game.
 *
 * \note 1) During some scenes of the game you might need the audio to be synchronized
 * with the flow of action. If the user tries to pause the game you will want to pause 
 * the audio so the audio doesn't go out of synch with the action. In order to do this, 
 * when you begin such a scene you need to call the SetPauseVolumeAction() function of 
 * the  GameSettings class with the argument SETTINGS_PAUSE_AUDIO. When you are finished 
 * with this type of scene, you must must MUST remember to set this member back to its 
 * original value.
 *****************************************************************************/ 
class PauseMode : public hoa_mode_manager::GameMode {
private:
  hoa_video::StillImage _saved_screen;

  float _saved_music_volume;
  float _saved_sound_volume;
public:
  PauseMode();
  ~PauseMode();
  
  void Reset();
  void Update();
  void Draw();
};

} // namespace hoa_pause

#endif

---