ScummVM
Wintermute::WintermuteEngine Class Reference

#include <wintermute.h>

+ Inheritance diagram for Wintermute::WintermuteEngine:
+ Collaboration diagram for Wintermute::WintermuteEngine:

Public Member Functions

 WintermuteEngine (OSystem *syst, const WMEGameDescription *desc)
 
 WintermuteEngine ()
 
 ~WintermuteEngine () override
 
virtual Wintermute::ConsolegetConsole ()
 
Common::Error run () override
 Init the engine and start its main loop. More...
 
bool hasFeature (EngineFeature f) const override
 Determine whether the engine supports the specified feature. More...
 
Common::SaveFileManagergetSaveFileMan ()
 
Common::Error loadGameState (int slot) override
 Load a game state. More...
 
bool canLoadGameStateCurrently () override
 Indicates whether a game state can be loaded. More...
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 Save a game state. More...
 
bool canSaveGameStateCurrently () override
 Indicates whether a game state can be saved. More...
 
- Public Member Functions inherited from Engine
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
virtual void initializePath (const Common::FSNode &gamePath)
 Init SearchMan according to the game path. More...
 
virtual void errorString (const char *buf_input, char *buf_output, int buf_output_size)
 Prepare an error string, which is printed by the error() function. More...
 
virtual GUI::DebuggergetDebugger ()
 Return the engine's debugger instance, if any. More...
 
void setDebugger (GUI::Debugger *debugger)
 Sets the engine's debugger. More...
 
GUI::DebuggergetOrCreateDebugger ()
 Return the engine's debugger instance, or create one if none is present. More...
 
virtual void syncSoundSettings ()
 Notify the engine that the sound settings in the config manager may have changed and that it hence should adjust any internal volume etc. More...
 
virtual void flipMute ()
 Flip mute all sound option. More...
 
virtual Common::String getSaveStateName (int slot) const
 Generates the savegame filename. More...
 
virtual Common::Error loadGameStream (Common::SeekableReadStream *stream)
 Load a game state. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 Save a game state. More...
 
bool saveGameDialog ()
 Shows the ScummVM save dialog, allowing users to save their game. More...
 
bool loadGameDialog ()
 Shows the ScummVM Restore dialog, allowing users to load a game. More...
 
void pauseEngine (bool pause)
 Pause or resume the engine. More...
 
bool isPaused () const
 Return whether the engine is currently paused or not. More...
 
void openMainMenuDialog ()
 Run the Global Main Menu Dialog. More...
 
uint32 getTotalPlayTime () const
 Get the total play time. More...
 
void setTotalPlayTime (uint32 time=0)
 Set the game time counter to the specified time. More...
 
Common::TimerManagergetTimerManager ()
 
Common::EventManagergetEventManager ()
 
Common::SaveFileManagergetSaveFileManager ()
 
void checkCD ()
 On some systems, check if the game appears to be run from CD. More...
 
void handleAutoSave ()
 Checks for whether it's time to do an autosave, and if so, does it. More...
 
void saveAutosaveIfEnabled ()
 Does an autosave immediately if autosaves are turned on. More...
 
virtual bool canSaveAutosaveCurrently ()
 Indicates whether an autosave can currently be saved. More...
 
virtual int getAutosaveSlot () const
 Returns the slot that should be used for autosaves. More...
 
bool shouldPerformAutoSave (int lastSaveTime)
 

Static Public Member Functions

static bool getGameInfo (const Common::FSList &fslist, Common::String &name, Common::String &caption)
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 Request the engine to quit. More...
 
static bool shouldQuit ()
 Return whether the ENGINE should quit respectively should return to the launcher. More...
 
static MetaEnginegetMetaEngine ()
 
static bool warnUserAboutUnsupportedGame ()
 Display a warning to the user that the game is not fully supported. More...
 

Private Member Functions

int init ()
 
void deinit ()
 
int messageLoop ()
 

Private Attributes

Wintermute::Console_debugger
 
BaseGame_game
 
Wintermute::DebuggerController_dbgController
 
const WMEGameDescription_gameDescription
 

Friends

class Console
 
class DebuggerController
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature { kSupportsSubtitleOptions, kSupportsRTL, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime }
 A feature in this context means an ability of the engine which can be either available or not. More...
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
virtual void pauseEngineIntern (bool pause)
 Actual implementation of pauseEngine by subclasses. More...
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 

Detailed Description

Definition at line 55 of file wintermute.h.

Constructor & Destructor Documentation

◆ WintermuteEngine() [1/2]

Wintermute::WintermuteEngine::WintermuteEngine ( OSystem syst,
const WMEGameDescription desc 
)

Definition at line 61 of file wintermute.cpp.

◆ WintermuteEngine() [2/2]

Wintermute::WintermuteEngine::WintermuteEngine ( )

Definition at line 54 of file wintermute.cpp.

◆ ~WintermuteEngine()

Wintermute::WintermuteEngine::~WintermuteEngine ( )
override

Definition at line 87 of file wintermute.cpp.

Member Function Documentation

◆ canLoadGameStateCurrently()

bool Wintermute::WintermuteEngine::canLoadGameStateCurrently ( )
overridevirtual

Indicates whether a game state can be loaded.

Reimplemented from Engine.

Definition at line 334 of file wintermute.cpp.

◆ canSaveGameStateCurrently()

bool Wintermute::WintermuteEngine::canSaveGameStateCurrently ( )
overridevirtual

Indicates whether a game state can be saved.

Reimplemented from Engine.

Definition at line 330 of file wintermute.cpp.

◆ deinit()

void Wintermute::WintermuteEngine::deinit ( )
private

Definition at line 315 of file wintermute.cpp.

◆ getConsole()

virtual Wintermute::Console* Wintermute::WintermuteEngine::getConsole ( )
inlinevirtual

Definition at line 61 of file wintermute.h.

◆ getGameInfo()

bool Wintermute::WintermuteEngine::getGameInfo ( const Common::FSList fslist,
Common::String name,
Common::String caption 
)
static

Definition at line 338 of file wintermute.cpp.

◆ getSaveFileMan()

Common::SaveFileManager* Wintermute::WintermuteEngine::getSaveFileMan ( )
inline

Definition at line 65 of file wintermute.h.

◆ hasFeature()

bool Wintermute::WintermuteEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Definition at line 97 of file wintermute.cpp.

◆ init()

int Wintermute::WintermuteEngine::init ( void  )
private

Definition at line 150 of file wintermute.cpp.

◆ loadGameState()

Common::Error Wintermute::WintermuteEngine::loadGameState ( int  slot)
overridevirtual

Load a game state.

Parameters
slotthe slot from which a savestate should be loaded
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Definition at line 320 of file wintermute.cpp.

◆ messageLoop()

int Wintermute::WintermuteEngine::messageLoop ( )
private

Definition at line 260 of file wintermute.cpp.

◆ run()

Common::Error Wintermute::WintermuteEngine::run ( )
overridevirtual

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 111 of file wintermute.cpp.

◆ saveGameState()

Common::Error Wintermute::WintermuteEngine::saveGameState ( int  slot,
const Common::String desc,
bool  isAutosave = false 
)
overridevirtual

Save a game state.

Parameters
slotthe slot into which the savestate should be stored
desca description for the savestate, entered by the user
isAutosaveExpected to be true if an autosave is being created
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Definition at line 325 of file wintermute.cpp.

Friends And Related Function Documentation

◆ Console

friend class Console
friend

Definition at line 81 of file wintermute.h.

◆ DebuggerController

friend class DebuggerController
friend

Definition at line 82 of file wintermute.h.

Member Data Documentation

◆ _dbgController

Wintermute::DebuggerController* Wintermute::WintermuteEngine::_dbgController
private

Definition at line 78 of file wintermute.h.

◆ _debugger

Wintermute::Console* Wintermute::WintermuteEngine::_debugger
private

Definition at line 76 of file wintermute.h.

◆ _game

BaseGame* Wintermute::WintermuteEngine::_game
private

Definition at line 77 of file wintermute.h.

◆ _gameDescription

const WMEGameDescription* Wintermute::WintermuteEngine::_gameDescription
private

Definition at line 79 of file wintermute.h.


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