ScummVM API documentation
Engine Class Referenceabstract
Inheritance diagram for Engine:
Access::AccessEngine Adl::AdlEngine Agi::AgiBase AGOS::AGOSEngine AGS::AGSEngine Asylum::AsylumEngine Avalanche::AvalancheEngine Bagel::BagelEngine Bbvs::BbvsEngine BladeRunner::BladeRunnerEngine Buried::BuriedEngine CGE2::CGE2Engine CGE::CGEEngine Chamber::ChamberEngine Chewy::ChewyEngine Cine::CineEngine Composer::ComposerEngine Crab::CrabEngine Cruise::CruiseEngine Cryo::CryoEngine CryOmni3D::CryOmni3DEngine Darkseed::DarkseedEngine Dgds::DgdsEngine Director::DirectorEngine DM::DMEngine Draci::DraciEngine Dragons::DragonsEngine Drascula::DrasculaEngine DreamWeb::DreamWebEngine Efh::EfhEngine Freescape::FreescapeEngine Gnap::GnapEngine Gob::GobEngine Griffon::GriffonEngine Grim::GrimEngine Groovie::GroovieEngine Hadesch::HadeschEngine HDB::HDBGame Hopkins::HopkinsEngine Hpl1::Hpl1Engine Hugo::HugoEngine Hypno::HypnoEngine ICB::IcbEngine Illusions::IllusionsEngine Immortal::ImmortalEngine Kingdom::KingdomGame Kyra::KyraEngine_v1 Lab::LabEngine LastExpress::LastExpressEngine Lilliput::LilliputEngine Lure::LureEngine M4::M4Engine MacVenture::MacVentureEngine Made::MadeEngine MADS::MADSEngine MM::MMEngine Mohawk::MohawkEngine Mortevielle::MortevielleEngine MTropolis::MTropolisEngine MutationOfJB::MutationOfJBEngine Myst3::Myst3Engine Nancy::NancyEngine Neverhood::NeverhoodEngine NGI::NGIEngine Parallaction::Parallaction Pegasus::PegasusEngine Petka::PetkaEngine Pink::PinkEngine Playground3d::Playground3dEngine Plumbers::PlumbersGame Prince::PrinceEngine Private::PrivateEngine QDEngine::QDEngineEngine Queen::QueenEngine Saga2::Saga2Engine Saga::SagaEngine Sci::SciEngine Scumm::ScummEngine Sherlock::SherlockEngine Sky::SkyEngine Sludge::SludgeEngine Stark::StarkEngine StarTrek::StarTrekEngine Supernova::SupernovaEngine Sword1::SwordEngine Sword25::Sword25Engine Sword2::Sword2Engine TeenAgent::TeenAgentEngine Testbed::TestbedEngine Tetraedge::TetraedgeEngine Tinsel::TinselEngine Titanic::TitanicEngine Toltecs::ToltecsEngine Toon::ToonEngine Touche::ToucheEngine Trecision::TrecisionEngine TsAGE::TSageEngine Tucker::TuckerEngine TwinE::TwinEEngine Twp::TwpEngine Ultima::Shared::UltimaEngine Ultima::Ultima8::Ultima8Engine VCruise::VCruiseEngine Voyeur::VoyeurEngine Wage::WageEngine Watchmaker::WatchmakerGame Wintermute::WintermuteEngine ZVision::ZVision

Public Types

enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 

Public Member Functions

MetaEnginegetMetaEngine () const
 
void setMetaEngine (MetaEngine *metaEngine)
 
PauseToken pauseEngine ()
 
bool isPaused () const
 
void openMainMenuDialog ()
 
uint32 getTotalPlayTime () const
 
void setTotalPlayTime (uint32 time=0)
 
Common::TimerManagergetTimerManager ()
 
Common::EventManagergetEventManager ()
 
Common::SaveFileManagergetSaveFileManager ()
 
bool existExtractedCDAudioFiles (uint track=1)
 
bool isDataAndCDAudioReadFromSameCD ()
 
void warnMissingExtractedCDAudio ()
 
void handleAutoSave ()
 
void saveAutosaveIfEnabled ()
 
virtual bool canSaveAutosaveCurrently ()
 
virtual int getAutosaveSlot () const
 

Static Public Member Functions

static void quitGame ()
 
static bool shouldQuit ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 

Public Attributes

OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 

Protected Attributes

Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Overloadable methods

All Engine subclasses should consider overloading some or all of the following methods.

virtual void pauseEngineIntern (bool pause)
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
virtual void initializePath (const Common::FSNode &gamePath)
 
virtual Common::Error run ()=0
 
virtual void errorString (const char *buf_input, char *buf_output, int buf_output_size)
 
virtual GUI::DebuggergetDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::DebuggergetOrCreateDebugger ()
 
virtual bool hasFeature (EngineFeature f) const
 
bool enhancementEnabled (int32 cls)
 
virtual void syncSoundSettings ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
virtual Common::Error loadGameState (int slot)
 
virtual Common::Error loadGameStream (Common::SeekableReadStream *stream)
 
void setGameToLoadSlot (int slot)
 
virtual bool canLoadGameStateCurrently (Common::U32String *msg=nullptr)
 
virtual Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
virtual bool canSaveGameStateCurrently (Common::U32String *msg=nullptr)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Member Enumeration Documentation

◆ EngineFeature

Engine features.

A feature in this context means an ability of the engine that can be either available or not.

See also
Engine::hasFeature()
Enumerator
kSupportsSubtitleOptions 

Enable the subtitle speed and toggle items in the Options section of the global main menu.

kSupportsReturnToLauncher 

The 'Return to launcher' feature is supported.

This means that EVENT_RETURN_TO_LAUNCHER is handled either directly, or indirectly (the engine calls and honors the result of the Engine::shouldQuit() method appropriately).

kSupportsLoadingDuringRuntime 

Loading save states during runtime is supported.

This means that the engine implements loadGameState() and canLoadGameStateCurrently(). If this feature is supported, then the corresponding MetaEngine must support the kSupportsListSaves feature.

kSupportsSavingDuringRuntime 

Loading save states during runtime is supported.

This means that the engine implements saveGameState() and canSaveGameStateCurrently(). If this feature is supported, then the corresponding MetaEngine must support the kSupportsListSaves feature.

kSupportsChangingOptionsDuringRuntime 

Changing the game settings during runtime is supported.

This enables showing the Engine Options tab in the config dialog accessed through the global main menu.

kSupportsArbitraryResolutions 

Arbitrary resolutions are supported.

This means that the engine allows the backend to override the resolution passed to OSystem::setupScreen. The engine will need to read the actual resolution used by the backend using OSystem::getWidth and OSystem::getHeight.

kSupportsHelp 

The game provides custom help.

This enables the help button in the main menu.

kSupportsQuitDialogOverride 

The engine provides overrides to the quit and exit to launcher dialogs.

Constructor & Destructor Documentation

◆ Engine()

Engine::Engine ( OSystem syst)

Create an instance of the engine.

◆ ~Engine()

virtual Engine::~Engine ( )
virtual

Destroy the engine instance.

Member Function Documentation

◆ runDialog()

virtual int Engine::runDialog ( GUI::Dialog dialog)
protectedvirtual

Run a GUI dialog.

Reimplemented in Twp::TwpEngine.

◆ initializePath()

virtual void Engine::initializePath ( const Common::FSNode gamePath)
virtual

Initialize SearchMan according to the game path.

By default, this adds the directory in non-flat mode with a depth of 4 as priority 0 to SearchMan.

Parameters
gamePathThe base directory of the game data.

Reimplemented in CryOmni3D::Versailles::CryOmni3DEngine_Versailles, Ultima::Ultima8::Ultima8Engine, Private::PrivateEngine, Tinsel::TinselEngine, HDB::HDBGame, Hypno::HypnoEngine, Crab::CrabEngine, Titanic::TitanicEngine, VCruise::VCruiseEngine, and Bagel::SpaceBar::SpaceBarEngine.

◆ run()

virtual Common::Error Engine::run ( )
pure virtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implemented in Agi::AgiBase, Mohawk::MohawkEngine_LivingBooks, Scumm::ScummEngine, Saga::SagaEngine, Touche::ToucheEngine, Tucker::TuckerEngine, Mortevielle::MortevielleEngine, BladeRunner::BladeRunnerEngine, Lilliput::LilliputEngine, Griffon::GriffonEngine, Drascula::DrasculaEngine, Hugo::HugoEngine, Efh::EfhEngine, Director::DirectorEngine, Prince::PrinceEngine, CryOmni3D::Versailles::CryOmni3DEngine_Versailles, Dragons::DragonsEngine, AGOS::AGOSEngine, Bbvs::BbvsEngine, Parallaction::Parallaction, StarTrek::StarTrekEngine, TwinE::TwinEEngine, CGE::CGEEngine, Gnap::GnapEngine, Pegasus::PegasusEngine, Lab::LabEngine, Kyra::KyraEngine_v1, MacVenture::MacVentureEngine, Dgds::DgdsEngine, DM::DMEngine, Immortal::ImmortalEngine, Trecision::TrecisionEngine, CryOmni3D::CryOmni3DEngine_HNMPlayer, Freescape::FreescapeEngine, CGE2::CGE2Engine, ZVision::ZVision, Ultima::Ultima8::Ultima8Engine, Voyeur::VoyeurEngine, Tinsel::TinselEngine, HDB::HDBGame, Private::PrivateEngine, Sword1::SwordEngine, Composer::ComposerEngine, Sword2::Sword2Engine, Sci::SciEngine, Sherlock::SherlockEngine, Hopkins::HopkinsEngine, Groovie::GroovieEngine, Wage::WageEngine, Cine::CineEngine, Mohawk::MohawkEngine_CSTime, Mohawk::MohawkEngine_Myst, Toon::ToonEngine, Nancy::NancyEngine, Hypno::HypnoEngine, Avalanche::AvalancheEngine, Queen::QueenEngine, Sky::SkyEngine, Lure::LureEngine, NGI::NGIEngine, Access::AccessEngine, Hadesch::HadeschEngine, Saga2::Saga2Engine, DreamWeb::DreamWebEngine, Stark::StarkEngine, Titanic::TitanicEngine, MADS::MADSEngine, Pink::PinkEngine, Petka::PetkaEngine, Crab::CrabEngine, Toltecs::ToltecsEngine, Ultima::Shared::UltimaEarlyEngine, Kingdom::KingdomGame, Mohawk::MohawkEngine_Riven, Myst3::Myst3Engine, Twp::TwpEngine, TsAGE::TSageEngine, Cruise::CruiseEngine, TeenAgent::TeenAgentEngine, Darkseed::DarkseedEngine, AGS::AGSEngine, CryOmni3D::CryOmni3DEngine, Illusions::IllusionsEngine_Duckman, Plumbers::PlumbersGame, Asylum::AsylumEngine, QDEngine::QDEngineEngine, Tetraedge::TetraedgeEngine, Ultima::Nuvie::NuvieEngine, Draci::DraciEngine, Sword25::Sword25Engine, LastExpress::LastExpressEngine, Made::MadeEngine, Sludge::SludgeEngine, Buried::BuriedEngine, Supernova::SupernovaEngine, M4::M4Engine, Illusions::IllusionsEngine_BBDOU, Neverhood::NeverhoodEngine, Grim::GrimEngine, MutationOfJB::MutationOfJBEngine, Ultima::Ultima4::Ultima4Engine, Chewy::ChewyEngine, Wintermute::WintermuteEngine, Cryo::CryoEngine, Mohawk::MohawkEngine, Hpl1::Hpl1Engine, MTropolis::MTropolisEngine, Chamber::ChamberEngine, ICB::IcbEngine, Watchmaker::WatchmakerGame, Testbed::TestbedEngine, VCruise::VCruiseEngine, Playground3d::Playground3dEngine, and Bagel::SpaceBar::SpaceBarEngine.

◆ errorString()

virtual void Engine::errorString ( const char *  buf_input,
char *  buf_output,
int  buf_output_size 
)
virtual

Prepare an error string that is printed by the error() function.

Reimplemented in Scumm::ScummEngine, Sci::SciEngine, and Nancy::NancyEngine.

◆ getDebugger()

virtual GUI::Debugger* Engine::getDebugger ( )
inlinefinalvirtual

Return the engine's debugger instance, if any.

◆ setDebugger()

void Engine::setDebugger ( GUI::Debugger debugger)
inline

Set the engine's debugger.

Once set, the Engine class is responsible for managing the debugger, and freeing it on exit.

◆ getOrCreateDebugger()

GUI::Debugger* Engine::getOrCreateDebugger ( )

Return the engine's debugger instance, or create one if none is present.

Used by error() to invoke the debugger when a severe error is reported.

◆ hasFeature()

virtual bool Engine::hasFeature ( EngineFeature  f) const
inlinevirtual

Determine whether the engine supports the specified feature.

Reimplemented in Immortal::ImmortalEngine, Agi::AgiBase, Scumm::ScummEngine, Freescape::FreescapeEngine, Hypno::SpiderEngine, Saga::SagaEngine, Touche::ToucheEngine, Tucker::TuckerEngine, Hypno::WetEngine, Mortevielle::MortevielleEngine, NGI::NGIEngine, Toon::ToonEngine, BladeRunner::BladeRunnerEngine, Drascula::DrasculaEngine, Lilliput::LilliputEngine, Hugo::HugoEngine, Prince::PrinceEngine, Efh::EfhEngine, CryOmni3D::Versailles::CryOmni3DEngine_Versailles, AGOS::AGOSEngine, Parallaction::Parallaction, ZVision::ZVision, Bbvs::BbvsEngine, Dragons::DragonsEngine, Dgds::DgdsEngine, TwinE::TwinEEngine, Gnap::GnapEngine, Lab::LabEngine, Kyra::KyraEngine_v1, Mohawk::MohawkEngine_Myst, MacVenture::MacVentureEngine, Grim::GrimEngine, Director::DirectorEngine, Trecision::TrecisionEngine, Private::PrivateEngine, Darkseed::DarkseedEngine, Ultima::Ultima8::Ultima8Engine, DM::DMEngine, CGE2::CGE2Engine, Composer::ComposerEngine, Voyeur::VoyeurEngine, CGE::CGEEngine, Tinsel::TinselEngine, Sword1::SwordEngine, HDB::HDBGame, Crab::CrabEngine, Sword2::Sword2Engine, Sci::SciEngine, Hopkins::HopkinsEngine, Groovie::GroovieEngine, Cine::CineEngine, Wage::WageEngine, Sky::SkyEngine, AGS::AGSEngine, Lure::LureEngine, Queen::QueenEngine, Mohawk::MohawkEngine_Riven, Access::AccessEngine, Hadesch::HadeschEngine, M4::M4Engine, Myst3::Myst3Engine, QDEngine::QDEngineEngine, Saga2::Saga2Engine, Twp::TwpEngine, DreamWeb::DreamWebEngine, Stark::StarkEngine, Titanic::TitanicEngine, Avalanche::AvalancheEngine, Toltecs::ToltecsEngine, Tetraedge::TetraedgeEngine, Pink::PinkEngine, MADS::MADSEngine, Petka::PetkaEngine, Sherlock::SherlockEngine, Cruise::CruiseEngine, CryOmni3D::CryOmni3DEngine, Kingdom::KingdomGame, TeenAgent::TeenAgentEngine, Buried::BuriedEngine, Nancy::NancyEngine, Illusions::IllusionsEngine_Duckman, Bagel::BagelEngine, Hpl1::Hpl1Engine, Pegasus::PegasusEngine, TsAGE::TSageEngine, Made::MadeEngine, Asylum::AsylumEngine, Draci::DraciEngine, Neverhood::NeverhoodEngine, Sword25::Sword25Engine, LastExpress::LastExpressEngine, Mohawk::MohawkEngine, Supernova::SupernovaEngine, MutationOfJB::MutationOfJBEngine, Illusions::IllusionsEngine_BBDOU, Chewy::ChewyEngine, Ultima::Shared::UltimaEngine, Wintermute::WintermuteEngine, Cryo::CryoEngine, MTropolis::MTropolisEngine, Testbed::TestbedEngine, Chamber::ChamberEngine, VCruise::VCruiseEngine, MM::MMEngine, ICB::IcbEngine, and Playground3d::Playground3dEngine.

◆ syncSoundSettings()

virtual void Engine::syncSoundSettings ( )
virtual

Notify the engine that the sound settings in the config manager might have changed and that it should adjust any internal volume (and other) values accordingly.

The default implementation sets the volume levels of all mixer sound types according to the config entries of the active domain. When overwriting, call the default implementation first, then adjust the volumes further (if required).

Note
When setting volume levels, respect the "mute" config entry.
The volume for the plain sound type is reset to the maximum volume. If the engine can associate its own value for this type, it needs to overwrite this member and set it accordingly.

Reimplemented in Agi::AgiEngine, Scumm::ScummEngine, Saga::SagaEngine, Touche::ToucheEngine, BladeRunner::BladeRunnerEngine, Griffon::GriffonEngine, Drascula::DrasculaEngine, Lilliput::LilliputEngine, Ultima::Ultima8::Ultima8Engine, Hugo::HugoEngine, Dragons::DragonsEngine, AGOS::AGOSEngine, ZVision::ZVision, MM::Xeen::XeenEngine, Toon::ToonEngine, Hopkins::HopkinsEngine, AGS::AGSEngine, Kyra::KyraEngine_v1, Crab::CrabEngine, Sherlock::SherlockEngine, MADS::MADSEngine, HDB::HDBGame, Darkseed::DarkseedEngine, Sword1::SwordEngine, Titanic::TitanicEngine, Sci::SciEngine, Sword2::Sword2Engine, Groovie::GroovieEngine, Cine::CineEngine, QDEngine::QDEngineEngine, Lure::LureEngine, Queen::QueenEngine, M4::M4Engine, Saga2::Saga2Engine, Cruise::CruiseEngine, Toltecs::ToltecsEngine, Chewy::ChewyEngine, Sky::SkyEngine, TsAGE::TSageEngine, Myst3::Myst3Engine, MM::MM1::MM1Engine, Ultima::Nuvie::NuvieEngine, Made::MadeEngine, Draci::DraciEngine, and VCruise::VCruiseEngine.

◆ applyGameSettings()

virtual void Engine::applyGameSettings ( )
inlinevirtual

Notify the engine that the settings editable from the Game tab in the in-game options dialog might have changed and that they need to be applied if necessary.

Reimplemented in Ultima::Ultima8::Ultima8Engine, Mohawk::MohawkEngine_Myst, Mohawk::MohawkEngine_Riven, and Petka::PetkaEngine.

◆ flipMute()

virtual void Engine::flipMute ( )
virtual

Flip mute all sound options.

◆ getSaveStateName()

◆ loadGameState()

virtual Common::Error Engine::loadGameState ( int  slot)
virtual

Load a game state.

Parameters
slotThe slot from which a save state should be loaded.
Returns
kNoError on success, otherwise an error code.

Reimplemented in Agi::AgiEngine, Tucker::TuckerEngine, Kyra::KyraEngine_HoF, Saga::SagaEngine, Touche::ToucheEngine, Scumm::ScummEngine, Bbvs::BbvsEngine, Mortevielle::MortevielleEngine, Kyra::KyraEngine_v1, NGI::NGIEngine, BladeRunner::BladeRunnerEngine, Toon::ToonEngine, Drascula::DrasculaEngine, Ultima::Ultima8::Ultima8Engine, Gnap::GnapEngine, Hugo::HugoEngine, Prince::PrinceEngine, Efh::EfhEngine, Access::AccessEngine, Adl::AdlEngine, CryOmni3D::Versailles::CryOmni3DEngine_Versailles, ZVision::ZVision, Dragons::DragonsEngine, Illusions::IllusionsEngine, Wage::WageEngine, Kingdom::KingdomGame, MM::Xeen::XeenEngine, Lab::LabEngine, Toltecs::ToltecsEngine, Kyra::KyraEngine_LoK, HDB::HDBGame, Voyeur::VoyeurEngine, Asylum::AsylumEngine, MacVenture::MacVentureEngine, Mohawk::MohawkEngine_Myst, DM::DMEngine, Hopkins::HopkinsEngine, CGE2::CGE2Engine, Crab::CrabEngine, AGS::AGSEngine, Sword2::Sword2Engine, CGE::CGEEngine, Tinsel::TinselEngine, Sword1::SwordEngine, Composer::ComposerEngine, Cine::CineEngine, Sherlock::SherlockEngine, MADS::MADSEngine, Lure::LureEngine, Sci::SciEngine, Titanic::TitanicEngine, Groovie::GroovieEngine, Tetraedge::TetraedgeEngine, Twp::TwpEngine, M4::M4Engine, Petka::PetkaEngine, Myst3::Myst3Engine, Neverhood::NeverhoodEngine, Saga2::Saga2Engine, DreamWeb::DreamWebEngine, Avalanche::AvalancheEngine, Stark::StarkEngine, Mohawk::MohawkEngine_Riven, Cruise::CruiseEngine, Pink::PinkEngine, Sky::SkyEngine, Bagel::BagelEngine, Ultima::Nuvie::NuvieEngine, Queen::QueenEngine, Hpl1::Hpl1Engine, TsAGE::TSageEngine, TeenAgent::TeenAgentEngine, Grim::GrimEngine, Draci::DraciEngine, Pegasus::PegasusEngine, MutationOfJB::MutationOfJBEngine, Supernova::SupernovaEngine, and Wintermute::WintermuteEngine.

◆ loadGameStream()

◆ setGameToLoadSlot()

void Engine::setGameToLoadSlot ( int  slot)

Set the game slot for a savegame to be loaded after the global main menu execution.

This is to avoid loading a savegame from inside the menu loop which causes bugs like #4420.

Parameters
slotThe slot from which a save state should be loaded.

◆ canLoadGameStateCurrently()

virtual bool Engine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
virtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented in Agi::AgiBase, Tucker::TuckerEngine, Immortal::ImmortalEngine, Saga::SagaEngine, Touche::ToucheEngine, Scumm::ScummEngine, Freescape::FreescapeEngine, Bbvs::BbvsEngine, Mortevielle::MortevielleEngine, NGI::NGIEngine, Kyra::KyraEngine_v1, BladeRunner::BladeRunnerEngine, Drascula::DrasculaEngine, Ultima::Ultima8::Ultima8Engine, Access::AccessEngine, Prince::PrinceEngine, Efh::EfhEngine, Hugo::HugoEngine, Dragons::DragonsEngine, ZVision::ZVision, MM::Xeen::XeenEngine, TwinE::TwinEEngine, Illusions::IllusionsEngine, Toon::ToonEngine, Dgds::DgdsEngine, Lab::LabEngine, Toltecs::ToltecsEngine, HDB::HDBGame, Voyeur::VoyeurEngine, Asylum::AsylumEngine, MacVenture::MacVentureEngine, Mohawk::MohawkEngine_Myst, Darkseed::DarkseedEngine, Trecision::TrecisionEngine, Private::PrivateEngine, DM::DMEngine, Hopkins::HopkinsEngine, Hypno::HypnoEngine, CGE2::CGE2Engine, Sword2::Sword2Engine, Tinsel::TinselEngine, CGE::CGEEngine, Cine::CineEngine, Sword1::SwordEngine, AGS::AGSEngine, Composer::ComposerEngine, Crab::CrabEngine, Lure::LureEngine, Sci::SciEngine, Buried::BuriedEngine, Sherlock::SherlockEngine, Groovie::GroovieEngine, MADS::MADSEngine, Titanic::TitanicEngine, Wage::WageEngine, Petka::PetkaEngine, Myst3::Myst3Engine, Twp::TwpEngine, M4::M4Engine, QDEngine::QDEngineEngine, Neverhood::NeverhoodEngine, Ultima::Shared::UltimaEngine, Hadesch::HadeschEngine, Saga2::Saga2Engine, Tetraedge::TetraedgeEngine, Avalanche::AvalancheEngine, Stark::StarkEngine, Cruise::CruiseEngine, Mohawk::MohawkEngine_Riven, Sherlock::Tattoo::TattooEngine, Pink::PinkEngine, Sky::SkyEngine, CryOmni3D::CryOmni3DEngine, Queen::QueenEngine, MM::MM1::MM1Engine, TeenAgent::TeenAgentEngine, TsAGE::TSageEngine, Grim::GrimEngine, M4::Burger::BurgerEngine, Nancy::NancyEngine, Bagel::BagelEngine, Chewy::ChewyEngine, Draci::DraciEngine, Hpl1::Hpl1Engine, Pegasus::PegasusEngine, MutationOfJB::MutationOfJBEngine, Supernova::SupernovaEngine, Wintermute::WintermuteEngine, VCruise::VCruiseEngine, and Chamber::ChamberEngine.

◆ saveGameState()

virtual Common::Error Engine::saveGameState ( int  slot,
const Common::String desc,
bool  isAutosave = false 
)
virtual

Save a game state.

Parameters
slotThe slot into which the save state should be stored.
descDescription for the save state, entered by the user.
isAutosaveExpected to be true if an autosave is being created.
Returns
kNoError on success, otherwise an error code.

Reimplemented in Agi::AgiEngine, Tucker::TuckerEngine, Saga::SagaEngine, Touche::ToucheEngine, Scumm::ScummEngine, Bbvs::BbvsEngine, Mortevielle::MortevielleEngine, Kyra::KyraEngine_v1, NGI::NGIEngine, BladeRunner::BladeRunnerEngine, Toon::ToonEngine, Drascula::DrasculaEngine, Ultima::Ultima8::Ultima8Engine, Gnap::GnapEngine, Hugo::HugoEngine, Prince::PrinceEngine, Efh::EfhEngine, Access::AccessEngine, Adl::AdlEngine, CryOmni3D::Versailles::CryOmni3DEngine_Versailles, ZVision::ZVision, Dragons::DragonsEngine, Illusions::IllusionsEngine, MM::Xeen::XeenEngine, Wage::WageEngine, Kingdom::KingdomGame, Lab::LabEngine, Toltecs::ToltecsEngine, Voyeur::VoyeurEngine, HDB::HDBGame, Asylum::AsylumEngine, MacVenture::MacVentureEngine, Mohawk::MohawkEngine_Myst, Hopkins::HopkinsEngine, AGS::AGSEngine, CGE2::CGE2Engine, Crab::CrabEngine, CGE::CGEEngine, Sword2::Sword2Engine, Sherlock::SherlockEngine, Sword1::SwordEngine, Composer::ComposerEngine, Cine::CineEngine, MADS::MADSEngine, Titanic::TitanicEngine, Lure::LureEngine, Sci::SciEngine, Groovie::GroovieEngine, Twp::TwpEngine, Petka::PetkaEngine, Myst3::Myst3Engine, Neverhood::NeverhoodEngine, Tetraedge::TetraedgeEngine, DreamWeb::DreamWebEngine, Saga2::Saga2Engine, Stark::StarkEngine, Mohawk::MohawkEngine_Riven, Ultima::Ultima4::Ultima4Engine, Cruise::CruiseEngine, Avalanche::AvalancheEngine, Ultima::Nuvie::NuvieEngine, Pink::PinkEngine, Sky::SkyEngine, Queen::QueenEngine, TsAGE::TSageEngine, Bagel::BagelEngine, TeenAgent::TeenAgentEngine, Draci::DraciEngine, Pegasus::PegasusEngine, MutationOfJB::MutationOfJBEngine, Supernova::SupernovaEngine, and Wintermute::WintermuteEngine.

◆ saveGameStream()

◆ canSaveGameStateCurrently()

virtual bool Engine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
virtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented in Agi::AgiBase, Tucker::TuckerEngine, Immortal::ImmortalEngine, Saga::SagaEngine, Touche::ToucheEngine, Scumm::ScummEngine, Freescape::FreescapeEngine, Bbvs::BbvsEngine, Mortevielle::MortevielleEngine, NGI::NGIEngine, Kyra::KyraEngine_v1, BladeRunner::BladeRunnerEngine, Drascula::DrasculaEngine, Ultima::Ultima8::Ultima8Engine, Access::AccessEngine, Prince::PrinceEngine, Efh::EfhEngine, Adl::AdlEngine, Hugo::HugoEngine, Dragons::DragonsEngine, ZVision::ZVision, MM::Xeen::XeenEngine, TwinE::TwinEEngine, Illusions::IllusionsEngine, Toon::ToonEngine, Dgds::DgdsEngine, Lab::LabEngine, Toltecs::ToltecsEngine, HDB::HDBGame, Voyeur::VoyeurEngine, Asylum::AsylumEngine, MacVenture::MacVentureEngine, Mohawk::MohawkEngine_Myst, Darkseed::DarkseedEngine, Private::PrivateEngine, Trecision::TrecisionEngine, Hopkins::HopkinsEngine, Hypno::HypnoEngine, CGE2::CGE2Engine, Sword2::Sword2Engine, CGE::CGEEngine, AGS::AGSEngine, Sword1::SwordEngine, Cine::CineEngine, Crab::CrabEngine, Composer::ComposerEngine, Lure::LureEngine, Sci::SciEngine, Sherlock::SherlockEngine, Buried::BuriedEngine, MADS::MADSEngine, Groovie::GroovieEngine, Titanic::TitanicEngine, Wage::WageEngine, Ultima::Shared::UltimaEngine, Petka::PetkaEngine, Twp::TwpEngine, QDEngine::QDEngineEngine, M4::M4Engine, Myst3::Myst3Engine, Neverhood::NeverhoodEngine, Hadesch::HadeschEngine, Saga2::Saga2Engine, Tetraedge::TetraedgeEngine, Cruise::CruiseEngine, Sherlock::Tattoo::TattooEngine, Stark::StarkEngine, Mohawk::MohawkEngine_Riven, Avalanche::AvalancheEngine, Pink::PinkEngine, Sky::SkyEngine, CryOmni3D::CryOmni3DEngine, Queen::QueenEngine, TeenAgent::TeenAgentEngine, TsAGE::TSageEngine, Chewy::ChewyEngine, Nancy::NancyEngine, Bagel::BagelEngine, MM::MM1::MM1Engine, Draci::DraciEngine, Pegasus::PegasusEngine, MTropolis::MTropolisEngine, MutationOfJB::MutationOfJBEngine, Supernova::SupernovaEngine, Wintermute::WintermuteEngine, VCruise::VCruiseEngine, Chamber::ChamberEngine, and Adl::AdlEngine_v2.

◆ saveGameDialog()

bool Engine::saveGameDialog ( )

Show the ScummVM save dialog, allowing users to save their game.

◆ loadGameDialog()

bool Engine::loadGameDialog ( )

Show the ScummVM Restore dialog, allowing users to load a game.

◆ pauseEngineIntern()

◆ quitGame()

static void Engine::quitGame ( )
static

Request the engine to quit.

Sends an EVENT_QUIT event to the Event Manager.

◆ shouldQuit()

static bool Engine::shouldQuit ( )
static

Return whether the engine should quit.

This can mean either quitting ScummVM altogether, or returning to the launcher.

◆ getMetaEngine()

MetaEngine* Engine::getMetaEngine ( ) const
inline

Return the MetaEngine instance used by this engine.

◆ setMetaEngine()

void Engine::setMetaEngine ( MetaEngine metaEngine)
inline

Set the MetaEngine instance used by this engine.

◆ pauseEngine()

PauseToken Engine::pauseEngine ( )

Pause the engine.

This should stop any audio playback and other operations. Called right before the system runs a global dialog (like a global pause, main menu, options, or 'confirm exit' dialog).

Returns a PauseToken. Multiple pause tokens can exist. The engine will be resumed when all associated pause tokens reach the end of their lives.

◆ isPaused()

bool Engine::isPaused ( ) const
inline

Return whether the engine is currently paused or not.

◆ openMainMenuDialog()

void Engine::openMainMenuDialog ( )

Run the global main menu dialog.

◆ warnUserAboutUnsupportedGame()

static bool Engine::warnUserAboutUnsupportedGame ( Common::String  msg = Common::String())
static

Display a warning to the user that the game is not fully supported.

Parameters
msgA message that will be presented to user. If empty, then generic message regarding unsupported game is presented
Returns
True if the user chooses to start anyway, false otherwise.

◆ errorUnsupportedGame()

static void Engine::errorUnsupportedGame ( Common::String  extraMsg)
static

Display an error message to the user that the game is not supported.

Parameters
extraMsgAn extra message that will be appended to the default message.

◆ getTotalPlayTime()

uint32 Engine::getTotalPlayTime ( ) const

Get the total play time.

Returns
How long the player has been playing in ms.

◆ setTotalPlayTime()

void Engine::setTotalPlayTime ( uint32  time = 0)

Set the game time counter to the specified time.

This can be used to set the play time counter after loading a savegame, for example. Another use case is when the engine wants to exclude from the counter the time that the user spent in original engine dialogs.

Parameters
timePlay time to set up in ms.

◆ getTimerManager()

Common::TimerManager* Engine::getTimerManager ( )
inline

Return the TimerManager instance used by this engine.

◆ getEventManager()

Common::EventManager* Engine::getEventManager ( )
inline

Return the EventManager instance used by this engine.

◆ getSaveFileManager()

Common::SaveFileManager* Engine::getSaveFileManager ( )
inline

Return the SaveFileManager instance used by this engine.

◆ existExtractedCDAudioFiles()

bool Engine::existExtractedCDAudioFiles ( uint  track = 1)

Check if extracted CD Audio files are found.

◆ isDataAndCDAudioReadFromSameCD()

bool Engine::isDataAndCDAudioReadFromSameCD ( )

On some systems, check whether the game appears to be run from the same CD drive, which also should play CD audio.

◆ warnMissingExtractedCDAudio()

void Engine::warnMissingExtractedCDAudio ( )

Display a warning for no extracted CD Audio files found.

◆ handleAutoSave()

void Engine::handleAutoSave ( )

Check whether it is time to autosave, and if so, do it.

◆ saveAutosaveIfEnabled()

void Engine::saveAutosaveIfEnabled ( )

Autosave immediately if autosaves are enabled.

◆ canSaveAutosaveCurrently()

◆ getAutosaveSlot()

virtual int Engine::getAutosaveSlot ( ) const
inlinevirtual

Return the slot that should be used for autosaves, or -1 for engines that don't support autosave.

Note
This should match the meta engine getAutosaveSlot() method.

Reimplemented in Tucker::TuckerEngine, BladeRunner::BladeRunnerEngine, Kyra::KyraEngine_v1, Bbvs::BbvsEngine, Adl::AdlEngine, Asylum::AsylumEngine, Sci::SciEngine, AGS::AGSEngine, Petka::PetkaEngine, Groovie::GroovieEngine, and Queen::QueenEngine.

◆ defaultSyncSoundSettings()

void Engine::defaultSyncSoundSettings ( )
protected

Syncs the engine's mixer using the default volume syncing behavior.

Member Data Documentation

◆ _system

OSystem* Engine::_system

The OSystem instance used by the engine.

◆ _mixer

Audio::Mixer* Engine::_mixer

The Mixer instance used by the engine.

◆ _timer

Common::TimerManager* Engine::_timer
protected

The TimerManager instance used by the engine.

◆ _eventMan

Common::EventManager* Engine::_eventMan
protected

The EventManager instance used by the engine.

◆ _saveFileMan

Common::SaveFileManager* Engine::_saveFileMan
protected

The SaveFileManager used by the engine.

◆ _mainMenuDialog

GUI::Dialog* Engine::_mainMenuDialog
protected

The Dialog instance used by the engine.

◆ _targetName

const Common::String Engine::_targetName
protected

Target name for saves.


The documentation for this class was generated from the following file: