ultima4.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 ULTIMA4_H
#define ULTIMA4_H

#include "common/random.h"
#include "engines/engine.h"
#include "ultima/detection.h"
#include "ultima/shared/std/containers.h"

namespace Ultima {
namespace Ultima4 {

class Armors;
class Codex;
class Config;
class Context;
class Death;
class DialogueLoaders;
class Items;
class GameController;
class MapLoaders;
class Moongates;
class Music;
class ResponseParts;
struct SaveGame;
class Screen;
class Shrines;
class SoundManager;
class Spells;
class TileMaps;
class TileRules;
class TileSets;
class Weapons;

class Ultima4Engine : public Engine {
private:
    Common::RandomSource _randomSource;

    const UltimaGameDescription *_gameDescription;

    int _saveSlotToLoad;
private:
    void startup();
protected:
    // Engine APIs
    Common::Error run() override;

    bool initialize();

    bool isDataRequired(Common::Path &folder, int &majorVersion, int &minorVersion);
public:
    Armors *_armors;
    Codex *_codex;
    Config *_config;
    Context *_context;
    Death *_death;
    DialogueLoaders *_dialogueLoaders;
    GameController *_game;
    Items *_items;
    MapLoaders *_mapLoaders;
    Moongates *_moongates;
    Music *_music;
    ResponseParts *_responseParts;
    SaveGame *_saveGame;
    Screen *_screen;
    Shrines *_shrines;
    SoundManager *_soundManager;
    Spells *_spells;
    TileMaps *_tileMaps;
    TileRules *_tileRules;
    TileSets *_tileSets;
    Weapons *_weapons;
    Std::vector<Common::String> _hawkwindText;
public:
    Ultima4Engine(OSystem *syst, const Ultima::UltimaGameDescription *gameDesc);
    ~Ultima4Engine() override;

    bool hasFeature(EngineFeature f) const override;

    bool isEnhanced() const;

    uint getRandomNumber(uint maxVal) { return _randomSource.getRandomNumber(maxVal); }

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

    bool canSaveGameStateCurrently(Common::U32String *msg = nullptr) 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 = false) override;

    void setToJourneyOnwards();

    void quitGame();
};

extern Ultima4Engine *g_ultima;

} // End of namespace Ultima4
} // End of namespace Ultima

#endif