ultima8.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef ULTIMA8_ULTIMA8
#define ULTIMA8_ULTIMA8

#include "common/events.h"
#include "common/random.h"
#include "common/stream.h"
#include "graphics/screen.h"
#include "ultima/shared/std/containers.h"
#include "ultima/ultima8/usecode/intrinsics.h"
#include "ultima/ultima8/misc/common_types.h"
#include "ultima/ultima8/games/game_info.h"
#include "ultima/ultima8/gfx/render_surface.h"
#include "ultima/ultima8/metaengine.h"
#include "ultima/detection.h"

namespace Ultima {
namespace Ultima8 {

class Debugger;
class Kernel;
class UCMachine;
class Game;
class Gump;
class GameMapGump;
class MenuGump;
class InverterGump;
class RenderSurface;
class PaletteManager;
class GameData;
class World;
class ObjectManager;
class FontManager;
class Mouse;
class AvatarMoverProcess;
class Texture;
class AudioMixer;
class ConfigFileManager;
struct GameInfo;

#define GAME_IS_U8 (Ultima8Engine::get_instance()->getGameInfo()->_type == GameInfo::GAME_U8)
#define GAME_IS_REMORSE (Ultima8Engine::get_instance()->getGameInfo()->_type == GameInfo::GAME_REMORSE)
#define GAME_IS_REGRET (Ultima8Engine::get_instance()->getGameInfo()->_type == GameInfo::GAME_REGRET)
#define GAME_IS_CRUSADER (GAME_IS_REMORSE || GAME_IS_REGRET)
#define GAME_IS_DEMO (Ultima8Engine::get_instance()->getGameInfo()->_ucOffVariant == GameInfo::GAME_UC_DEMO)

class Ultima8Engine : public Engine {
    friend class Debugger;
private:
    Common::RandomSource _randomSource;

    bool _isRunning;
    GameInfo *_gameInfo;
    const UltimaGameDescription *_gameDescription;

    // minimal system
    ConfigFileManager *_configFileMan;

    static Ultima8Engine *_instance;

    bool _fontOverride;
    bool _fontAntialiasing;
    // Audio Mixer
    AudioMixer *_audioMixer;
    uint32 _saveCount;

    // full system
    Game *_game;
    Common::Error _lastError;

    Kernel *_kernel;
    ObjectManager *_objectManager;
    UCMachine *_ucMachine;
    RenderSurface *_screen;
    Mouse *_mouse;
    PaletteManager *_paletteManager;
    GameData *_gameData;
    World *_world;
    FontManager *_fontManager;

    Gump *_desktopGump;
    GameMapGump *_gameMapGump;
    InverterGump *_inverterGump;
    AvatarMoverProcess *_avatarMoverProcess;

    // Various dependency flags
    // Timing stuff
    int32 _lerpFactor;       
    bool _inBetweenFrame;    
    uint32 _priorFrameCounterTime;

    bool _highRes;           
    bool _frameSkip;         
    bool _frameLimit;        
    bool _interpolate;       
    int32 _animationRate;    

    // Sort of Camera Related Stuff, move somewhere else

    bool _avatarInStasis;    
    bool _paintEditorItems;  
    bool _showTouching;          
    int32 _timeOffset;
    bool _hasCheated;
    bool _cheatsEnabled;
    unsigned int _inversion;
    bool _crusaderTeleporting; 
    uint32 _moveKeyFrame; 
    bool _cruStasis; 
private:
    void showSplashScreen();

    void writeSaveInfo(Common::WriteStream *ws);

    void save(Common::WriteStream *ws);

    bool load(Common::ReadStream *rs, uint32 version);

    void resetEngine();

    void setupCoreGumps();

//  void fullReset();

    void handleDelayedEvents();

    bool pollEvent(Common::Event &event);
protected:
    // Engine APIs
    Common::Error run() override;

    Common::Error initialize();
    void deinitialize();

    void pauseEngineIntern(bool pause) override;

public:
    Ultima8Engine(OSystem *syst, const Ultima::UltimaGameDescription *gameDesc);
    ~Ultima8Engine() override;

    void initializePath(const Common::FSNode &gamePath) override;

    static Ultima8Engine *get_instance() {
        return _instance;
    }

    bool hasFeature(EngineFeature f) const override;

    Common::Language getLanguage() const;

    bool setupGame();
    Common::Error startupGame();

    void changeVideoMode(int width, int height);

    const GameInfo *getGameInfo() const {
        return _gameInfo;
    }

    RenderSurface *getRenderScreen() {
        return _screen;
    }

    Graphics::Screen *getScreen() const;

    Common::Error runGame();
    virtual void handleEvent(const Common::Event &event);

    void handleActionDown(KeybindingAction action);
    void handleActionUp(KeybindingAction action);

    void paint();

    static const int U8_DEFAULT_SCREEN_WIDTH = 320;
    static const int U8_DEFAULT_SCREEN_HEIGHT = 200;
    static const int CRUSADER_DEFAULT_SCREEN_WIDTH = 640;
    static const int CRUSADER_DEFAULT_SCREEN_HEIGHT = 480;

    static const int U8_HIRES_SCREEN_WIDTH = 640;
    static const int U8_HIRES_SCREEN_HEIGHT = 400;
    static const int CRUSADER_HIRES_SCREEN_WIDTH = 1024;
    static const int CRUSADER_HIRES_SCREEN_HEIGHT = 768;

    INTRINSIC(I_getCurrentTimerTick);
    INTRINSIC(I_setAvatarInStasis);
    INTRINSIC(I_getAvatarInStasis);
    INTRINSIC(I_getTimeInGameHours);
    INTRINSIC(I_getTimeInMinutes);
    INTRINSIC(I_getTimeInSeconds);
    INTRINSIC(I_setTimeInGameHours);
    INTRINSIC(I_avatarCanCheat);
    INTRINSIC(I_getCrusaderTeleporting);
    INTRINSIC(I_setCrusaderTeleporting);
    INTRINSIC(I_clrCrusaderTeleporting);
    INTRINSIC(I_makeAvatarACheater);
    INTRINSIC(I_closeItemGumps);
    INTRINSIC(I_setCruStasis);
    INTRINSIC(I_clrCruStasis);
    INTRINSIC(I_moveKeyDownRecently);

    void setAvatarInStasis(bool stat) {
        _avatarInStasis = stat;
    }
    bool isAvatarInStasis() const {
        return _avatarInStasis;
    }
    void toggleAvatarInStasis() {
        _avatarInStasis = !_avatarInStasis;
    }
    bool isPaintEditorItems() const {
        return _paintEditorItems;
    }
    void togglePaintEditorItems() {
        _paintEditorItems = !_paintEditorItems;
    }
    bool isShowTouchingItems() const {
        return _showTouching;
    }
    void toggleShowTouchingItems() {
        _showTouching = !_showTouching;
    }

    bool isCrusaderTeleporting() const {
        return _crusaderTeleporting;
    }
    void setCrusaderTeleporting(bool flag) {
        _crusaderTeleporting = flag;
    }
    void setCruStasis(bool flag) {
        _cruStasis = flag;
    }
    bool isCruStasis() const {
        return _cruStasis;
    }

    void moveKeyEvent();
    bool moveKeyDownRecently();

    uint32 getGameTimeInSeconds();

    GameMapGump *getGameMapGump() {
        return _gameMapGump;
    }
    Gump *getDesktopGump() {
        return _desktopGump;
    }
    Gump *getGump(uint16 gumpid);

    void addGump(Gump *gump);

    AvatarMoverProcess *getAvatarMoverProcess() {
        return _avatarMoverProcess;
    }

    Common::RandomSource &getRandomSource() {
        return _randomSource;
    }

    void syncSoundSettings() override;

    void applyGameSettings() override;

    void openConfigDialog();

    bool canLoadGameStateCurrently(Common::U32String *msg = nullptr) override { return true; }

    bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) override;

    Common::Error loadGameState(int slot) override;

    Common::Error saveGameState(int slot, const Common::String &desc, bool isAutosave = false) override;

    Common::Error loadGameStream(Common::SeekableReadStream *stream) override;

    Common::Error saveGameStream(Common::WriteStream *stream, bool isAutosave) override;

    bool newGame(int saveSlot = -1);

    void setError(Common::Error &error);
public:
    unsigned int getInversion() const {
        return _inversion;
    }
    void setInversion(unsigned int i) {
        _inversion = i & 0xFFFF;
    }
    bool isInverted() {
        return (_inversion >= 0x4000 && _inversion < 0xC000);
    }
public:
    bool areCheatsEnabled() const {
        return _cheatsEnabled;
    }
    void setCheatMode(bool enabled) {
        _cheatsEnabled = enabled;
    }
    bool hasCheated() const {
        return _hasCheated;
    }
    void makeCheater() {
        _hasCheated = true;
    }
    bool isInterpolationEnabled() const {
        return _interpolate;
    }
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif