Files
scummvm-cursorfix/engines/private/metaengine.cpp
2026-02-02 04:50:13 +01:00

158 lines
4.7 KiB
C++

/* 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/>.
*
*/
#include "engines/advancedDetector.h"
#include "graphics/scaler.h"
#include "common/savefile.h"
#include "common/translation.h"
#include "private/private.h"
#include "private/detection.h"
#include "private/savegame.h"
#include "backends/keymapper/action.h"
#include "backends/keymapper/keymapper.h"
#include "backends/keymapper/standard-actions.h"
static const ADExtraGuiOptionsMap optionsList[] = {
{
GAMEOPTION_SFX_SUBTITLES,
{
_s("Display SFX subtitles"),
_s("Use SFX subtitles (if subtitles are enabled)."),
"sfxSubtitles",
false,
0,
0
}
},
{
GAMEOPTION_HIGHLIGHT_MASKS,
{
_s("Highlight decision areas"),
_s("Highlight clickable areas in decision scenes."),
"highlightMasks",
false,
0,
0
}
},
AD_EXTRA_GUI_OPTIONS_TERMINATOR
};
class PrivateMetaEngine : public AdvancedMetaEngine<ADGameDescription> {
public:
const char *getName() const override {
return "private";
}
const ADExtraGuiOptionsMap *getAdvancedExtraGuiOptions() const override {
return optionsList;
}
Common::Error createInstance(OSystem *syst, Engine **engine, const ADGameDescription *desc) const override;
void getSavegameThumbnail(Graphics::Surface &thumb) override;
SaveStateDescriptor querySaveMetaInfos(const char *target, int slot) const override;
Common::KeymapArray initKeymaps(const char *target) const override;
};
Common::Error PrivateMetaEngine::createInstance(OSystem *syst, Engine **engine, const ADGameDescription *gd) const {
*engine = new Private::PrivateEngine(syst, gd);
return Common::kNoError;
}
void PrivateMetaEngine::getSavegameThumbnail(Graphics::Surface &thumb) {
byte *palette;
bool isNewPalette;
Graphics::Surface *vs = Private::g_private->decodeImage(Private::g_private->_nextVS, &palette, &isNewPalette);
::createThumbnail(&thumb, (const uint8 *)vs->getPixels(), vs->w, vs->h, palette);
vs->free();
delete vs;
if (isNewPalette) {
free(palette);
}
}
/**
* querySaveMetaInfos override that filters out saves with incompatible formats.
*
* The Private Eye save format was significantly changed to add more engine state.
* Older saves are incompatible, and we might have to change the format again.
* Save files now contain a version number in their header so that we can detect
* that a save is compatible, and not present incompatible saves to users.
*/
SaveStateDescriptor PrivateMetaEngine::querySaveMetaInfos(const char *target, int slot) const {
using namespace Private;
SaveStateDescriptor desc = MetaEngine::querySaveMetaInfos(target, slot);
if (desc.getSaveSlot() == -1) {
return desc;
}
// Only saves with compatible metadata headers are allowed.
Common::ScopedPtr<Common::InSaveFile> f(g_system->getSavefileManager()->openForLoading(
getSavegameFile(slot, target)));
if (f) {
SavegameMetadata meta;
if (!readSavegameMetadata(f.get(), meta)) {
return SaveStateDescriptor();
}
}
return desc;
}
Common::KeymapArray PrivateMetaEngine::initKeymaps(const char *target) const {
using namespace Common;
using namespace Private;
Keymap *engineKeymap = new Keymap(Keymap::kKeymapTypeGame, "private-default", _("Default keymappings"));
Action *act;
act = new Action(kStandardActionLeftClick, _("Select / Interact"));
act->setLeftClickEvent();
act->addDefaultInputMapping("MOUSE_LEFT");
act->addDefaultInputMapping("JOY_A");
engineKeymap->addAction(act);
act = new Action("SKIP", _("Skip video"));
act->setCustomEngineActionEvent(kActionSkip);
act->addDefaultInputMapping("ESCAPE");
act->addDefaultInputMapping("JOY_X");
engineKeymap->addAction(act);
return Keymap::arrayOf(engineKeymap);
}
namespace Private {
bool PrivateEngine::isDemo() const {
return (bool)(_gameDescription->flags & ADGF_DEMO);
}
} // End of namespace Private
#if PLUGIN_ENABLED_DYNAMIC(PRIVATE)
REGISTER_PLUGIN_DYNAMIC(PRIVATE, PLUGIN_TYPE_ENGINE, PrivateMetaEngine);
#else
REGISTER_PLUGIN_STATIC(PRIVATE, PLUGIN_TYPE_ENGINE, PrivateMetaEngine);
#endif