File indexing completed on 2024-10-13 03:43:40

 /*
     SPDX-FileCopyrightText: 2003 Marco Krüger <grisuji@gmx.de>
     SPDX-FileCopyrightText: 2003 Ian Wadham <iandw.au@gmail.com>
     SPDX-FileCopyrightText: 2009 Ian Wadham <iandw.au@gmail.com>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef KGRGAME_H
 #define KGRGAME_H
 
 #include "kgrglobals.h"
 
 #include <QObject>
 #include <QList>
 
 /**
  * Sets up games and levels in KGoldrunner and controls the play.
  *
  * @short   KGoldrunner Game Controller.
  */
 class KGrView;
 class KGrScene;
 class QDialog;
 
 class KGrSounds;
 
 class KGrEditor;
 class KGrLevelPlayer;
 class QRandomGenerator;
 class QTimer;
 
 class KGrGame : public QObject
 {
 Q_OBJECT
 public:
     KGrGame (KGrView * theView,
              const QString & theSystemDir, const QString & theUserDir);
     ~KGrGame() override;
 
     bool initGameLists();
 
     void setInitialTheme (const QString & themeFilepath);
 
     bool inEditMode();          // True if the game is in editor mode.
 
     bool saveOK();          // Check if edits were saved.
 
     // Flags to control author's debugging aids.
     static bool bugFix;
     static bool logging;
 
 public Q_SLOTS:
     void initGame();            // Do the game object's first painting.
 
     void gameActions        (const int action);
     void editActions        (const int action);
     void editToolbarActions (const int action);
     void settings           (const int action);
 
     void kbControl          (const int dirn, const bool pressed = true);
 
     void incScore           (const int n);  // Update the score.
 
     // Play or stop sound.  Default is play: only FallSound can be stopped.
     void playSound          (const int n, const bool onOff = true);
 
 private:
     void quickStartDialog();
 
     bool modeSwitch (const int action,
                      int & selectedGame, int & selectedLevel);
     bool selectGame (const SelectAction slAction,
                      int & selectedGame, int & selectedLevel);
 
     void toggleSoundsOnOff (const int action);  // Enable or disable sounds.
 
     // Set mouse, keyboard or laptop-hybrid control of the hero.
     void setControlMode (const int mode);
     void setHoldKeyOption (const int option);
     void setTimeScale (const int action);
 
     void newGame   (const int lev, const int gameIndex);
     void runReplay (const int action,
                     const int selectedGame, const int selectedLevel);
     bool getRecordingName (const QString & dir, const QString & pPrefix,
                            QString & filename);
     bool startDemo (const Owner demoOwner, const QString & pPrefix,
                                            const int levelNo);
     void runNextDemoLevel();
     void finishDemo();
 
 private Q_SLOTS:
     void interruptDemo();
 
 private:
     void startInstantReplay();
     void replayLastLevel();
 
     void showHint();            // Show hint for current level.
 
     QString getTitle();     // Collection - Level NNN, Name.
 
     void showHighScores();      // Show high scores for current game.
 
     void freeze (const bool userAction, const bool on_off);
 
     QString getDirectory (Owner o);
 
     void herosDead();           // Hero was caught or he quit (key Q).
     void levelCompleted();      // Hero completed the level.
 
     // Save game ID, score and level.
     void saveGame();
 
     // Select a saved game, score and level.
     bool selectSavedGame (int & selectedGame, int & selectedLevel);
 
     // Load and run a saved game, score and level.
     void loadGame (const int index, const int lev);
 
     QString loadedData;
 
 private Q_SLOTS:
     void endLevel (const int result);   // Hero completed the level or he died.
 
     void finalBreath();         // Hero is dead: end the death-scene.
     void repeatLevel();         // Hero is dead: repeat the level.
     void goUpOneLevel();        // Start next level.
 
 Q_SIGNALS:
     // These signals go to the GUI in most cases.
     void showScore (long);      // For main window to show the score.
     void showLives (long);      // For main window to show lives left.
 
     void hintAvailable (bool);      // For main window to adjust menu text.
 
     void setEditMenu (bool);        // Enable/Disable edit menu items.
 
     void gameFreeze (bool);     // Do visual feedback in the GUI.
 
     void quitGame();            // Used for Quit option in Quick Start.
 
     // Used to set/clear toggle actions and enable/disable actions.
     void setToggle (const QString &actionName, const bool onOff);
     void setAvail  (const QString &actionName, const bool onOff);
 
 private:
     QDialog * qs;           // Pointer to Quick Start dialog box.
     QString initialThemeFilepath;
 
 private Q_SLOTS:
     void quickStartPlay();
     void quickStartNewGame();
     void quickStartUseMenu();
     void quickStartQuit();
 
 private:
     bool playLevel (const Owner fileOwner, const QString & prefix,
                     const int levelNo, const bool newLevel);
     void setupLevelPlayer();
     void showTutorialMessages (int levelNo);
     void setPlayback (const bool onOff);
 
     void checkHighScore();      // Check if high score for current game.
 
     int  selectedGame;
 
 /******************************************************************************/
 /**************************  PLAYFIELD AND GAME DATA  *************************/
 /******************************************************************************/
 
     QRandomGenerator *          randomGen;  // Random number generator.
     KGrLevelPlayer *            levelPlayer;    // Where the level is played.
     KGrRecording *              recording;  // A recording of the play.
     bool                        playback;   // Play back or record?
 
     KGrView     *       view;       // Where the game is displayed.
     KGrScene    *               scene;          // Where the graphics are.
 
     QString         systemDataDir;  // System games are stored here.
     QString         userDataDir;    // User games are stored here.
     int                         timeScale;  // The speed of the game (2-20).
 
     QList<KGrGameData *>        gameList;   // A list of available games.
     int             gameIndex;  // The index in the game-list.
     Owner           owner;      // The game's owner.
 
     QString                     prefix;     // Prefix for game or demo file.
     int             level;      // Current play/edit/demo level.
     int                         levelMax;   // Last level no in game/demo.
     QString         levelName;  // Level name (optional).
     QString         levelHint;  // Level hint (optional).
 
     QString                     mainDemoName;   // File-prefix for Main Demo.
     GameAction                  demoType;   // The type of replay or demo.
     bool                        startupDemo;    // Startup demo running?
 
     Owner                       playbackOwner;  // Owner for current demo-file.
     QString                     playbackPrefix; // File-prefix for current demo.
     int                         playbackIndex;  // Record-index for curr demo.
     int                         playbackMax;    // Max index for current demo.
 
     long            lives;      // Lives remaining.
     long            score;      // Current score.
     long            startScore; // Score at start of level.
 
     bool            gameFrozen; // Game stopped.
     bool            programFreeze;  // Stop game during dialog, etc.
 
     QTimer *            dyingTimer; // For pause when the hero dies.
 
     int             lgHighlight;    // Row selected in "loadGame()".
 
 /******************************************************************************/
 /*******************************  SOUND SUPPORT *******************************/
 /******************************************************************************/
     KGrSounds * effects;
     QList<int> fx;
     bool soundOn;
     bool stepsOn;
 
 public Q_SLOTS:
     void dbgControl (const int code);   // Authors' debugging aids.
 
 private:
     KGrEditor * editor;     // The level-editor object.
 
     int controlMode;        // How to control the hero (e.g. K/B or mouse).
     int holdKeyOption;      // Whether K/B control is by holding or clicking keys.
 
 /******************************************************************************/
 /***********************   GAME PROPERTIES AND METHODS   **********************/
 /******************************************************************************/
 
     bool loadGameData      (Owner);
     void saveSolution      (const QString & prefix, const int levelNo);
     bool initRecordingData (const Owner fileOwner, const QString & prefix,
                             const int levelNo, const bool pPlayback);
     void saveRecording     (const QString & filetype); // Type "rec_" or "sol_".
     bool loadRecording     (const QString & dir,   const QString & prefix,
                                                    const int levelNo);
     void loadSounds();
 
 /******************************************************************************/
 /**********************    WORD-WRAPPED MESSAGE BOX    ************************/
 /******************************************************************************/
 
     void myMessage (QWidget * parent, const QString &title, const QString &contents);
 };
 
 #endif // KGRGAME_H