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 ()
 
virtual Wintermute::ConsolegetConsole ()
 
void trigDebugger ()
 
virtual Common::Error run ()
 Init the engine and start its main loop. More...
 
virtual bool hasFeature (EngineFeature f) const
 Determine whether the engine supports the specified feature. More...
 
Common::SaveFileManagergetSaveFileMan ()
 
virtual Common::Error loadGameState (int slot)
 Load a game state. More...
 
virtual bool canLoadGameStateCurrently ()
 Indicates whether a game state can be loaded. More...
 
virtual Common::Error saveGameState (int slot, const Common::String &desc)
 Save a game state. More...
 
virtual bool canSaveGameStateCurrently ()
 Indicates whether a game state can be saved. More...
 
- Public Member Functions inherited from Engine
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...
 
 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...
 
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 initKeymap ()
 
virtual void deinitKeymap ()
 
virtual void flipMute ()
 Flip mute all sound option. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 

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 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

bool _trigDebug
 
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,
  kSupportsJoystick
}
 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)
 
bool shouldPerformAutoSave (int lastSaveTime)
 Indicate whether an autosave should be performed. More...
 
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 53 of file wintermute.h.

Constructor & Destructor Documentation

◆ WintermuteEngine() [1/2]

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

Definition at line 62 of file wintermute.cpp.

◆ WintermuteEngine() [2/2]

Wintermute::WintermuteEngine::WintermuteEngine ( )

Definition at line 54 of file wintermute.cpp.

◆ ~WintermuteEngine()

Wintermute::WintermuteEngine::~WintermuteEngine ( )

Definition at line 89 of file wintermute.cpp.

Member Function Documentation

◆ canLoadGameStateCurrently()

bool Wintermute::WintermuteEngine::canLoadGameStateCurrently ( )
virtual

Indicates whether a game state can be loaded.

Reimplemented from Engine.

Definition at line 326 of file wintermute.cpp.

◆ canSaveGameStateCurrently()

bool Wintermute::WintermuteEngine::canSaveGameStateCurrently ( )
virtual

Indicates whether a game state can be saved.

Reimplemented from Engine.

Definition at line 322 of file wintermute.cpp.

◆ deinit()

void Wintermute::WintermuteEngine::deinit ( )
private

Definition at line 307 of file wintermute.cpp.

◆ getConsole()

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

Definition at line 59 of file wintermute.h.

◆ getGameInfo()

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

Definition at line 330 of file wintermute.cpp.

◆ getSaveFileMan()

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

Definition at line 64 of file wintermute.h.

◆ hasFeature()

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

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Definition at line 99 of file wintermute.cpp.

◆ init()

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

Definition at line 147 of file wintermute.cpp.

◆ loadGameState()

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

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 312 of file wintermute.cpp.

◆ messageLoop()

int Wintermute::WintermuteEngine::messageLoop ( )
private

Definition at line 246 of file wintermute.cpp.

◆ run()

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

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 113 of file wintermute.cpp.

◆ saveGameState()

Common::Error Wintermute::WintermuteEngine::saveGameState ( int  slot,
const Common::String desc 
)
virtual

Save a game state.

Parameters
slotthe slot into which the savestate should be stored
desca description for the savestate, entered by the user
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Definition at line 317 of file wintermute.cpp.

◆ trigDebugger()

void Wintermute::WintermuteEngine::trigDebugger ( )
inline

Definition at line 60 of file wintermute.h.

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.

◆ _trigDebug

bool Wintermute::WintermuteEngine::_trigDebug
private

Definition at line 72 of file wintermute.h.


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