gameloader.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 NGI_GAMELOADER_H
#define NGI_GAMELOADER_H

#include "common/ptr.h"
#include "engines/savestate.h"

#include "ngi/objects.h"
#include "ngi/inventory.h"
#include "ngi/messages.h"

namespace NGI {

#define NGI_SAVEGAME_VERSION 2

class SceneTag;
class MctlCompound;
class InputController;
class InteractionController;
class MotionController;
class MovGraph;

class Sc2 : public CObject {
 public:
    int16 _sceneId;
    int16 _field_2;
    Scene *_scene;
    MotionController *_motionController;
    Common::Array<int32> _data1; // FIXME, could be a struct
    PicAniInfoList _defPicAniInfos;
    PicAniInfoList _picAniInfos;
    bool _isLoaded;
    Common::Array<EntranceInfo> _entranceData;

 public:
    Sc2();
    ~Sc2() override;
    bool load(MfcArchive &file) override;
};

typedef Common::Array<Sc2> Sc2Array;

struct PreloadItem {
    int preloadId1;
    int preloadId2;
    int sceneId;
    int param;
};

bool preloadCallback(PreloadItem &pre, int flag);

class PreloadItems : public Common::Array<PreloadItem>, public CObject {
 public:
    bool load(MfcArchive &file) override;
};

struct FullpipeSavegameHeader {
    char id[6];
    uint8 version;
    Common::String saveName;
    Common::String description;
    uint32 date;
    uint16 time;
    uint32 playtime;
    Graphics::Surface *thumbnail;
};

struct SaveHeader {
    int32 version;
    char magic[32];
    int32 updateCounter;
    int32 unkField;
    int32 encSize;
};

class GameLoader : public CObject {
 public:
    GameLoader();
    ~GameLoader() override;

    bool load(MfcArchive &file) override;
    bool loadScene(int sceneId);
    bool gotoScene(int sceneId, int entranceId);
    bool preloadScene(int sceneId, int entranceId);
    bool unloadScene(int sceneId);

    void addPreloadItem(const PreloadItem &item);

    void updateSystems(int counterdiff);

    int getSceneTagBySceneId(int sceneId, SceneTag **st);
    void applyPicAniInfos(Scene *sc, const PicAniInfoList &picAniInfo);
    void saveScenePicAniInfos(int sceneId);
    PicAniInfoList savePicAniInfos(Scene *sc, int flag1, int flag2);

    bool readSavegame(const char *fname);
    bool writeSavegame(Scene *sc, const char *fname, const Common::String &description);

    void addVar(GameVar *var, GameVar *subvar);

    void restoreDefPicAniInfos();

    Common::ScopedPtr<GameProject> _gameProject;
    InteractionController *_interactionController;
    InputController *_inputController;
    Inventory2 _inventory;
    Sc2Array _sc2array;
    void *_sceneSwitcher;
    bool (*_preloadCallback)(PreloadItem &pre, int flag);
    void (*_savegameCallback)(MfcArchive *archive, bool mode);
    int16 _field_F8;
    int16 _field_FA;
    PreloadItems _preloadItems;
    GameVar *_gameVar;
    Common::String _gameName;
    ExCommand _exCommand;
    int _updateCounter;
    int _preloadSceneId;
    int _preloadEntranceId;
};

const char *getSavegameFile(int saveGameIdx);
WARN_UNUSED_RESULT bool readSavegameHeader(Common::InSaveFile *in, FullpipeSavegameHeader &header, bool skipThumbnail = true);
void parseSavegameHeader(NGI::FullpipeSavegameHeader &header, SaveStateDescriptor &desc);

Inventory2 *getGameLoaderInventory();
InteractionController *getGameLoaderInteractionController();
MctlCompound *getSc2MctlCompoundBySceneId(int16 sceneId);
MovGraph *getSc2MovGraphBySceneId(int16 sceneId);
MctlCompound *getCurrSceneSc2MotionController();

} // End of namespace NGI

#endif /* NGI_GAMELOADER_H */