Sludge::SludgeEngine Class Reference

#include <sludge.h>

+ Inheritance diagram for Sludge::SludgeEngine:
+ Collaboration diagram for Sludge::SludgeEngine:

Public Member Functions

 SludgeEngine (OSystem *syst, const SludgeGameDescription *gameDesc)
 ~SludgeEngine () override
uint getLanguageID () const
const char * getGameId () const
uint32 getFeatures () const
Common::Language getLanguage () const
Graphics::PixelFormatgetScreenPixelFormat () const
Graphics::PixelFormatgetOrigPixelFormat () const
Common::RandomSourcegetRandomSource () const
const char * getGameFile () const
- 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 bool hasFeature (EngineFeature f) const
 Determine whether the engine supports the specified feature. 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 loadGameState (int slot)
 Load a game state. 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 bool canLoadGameStateCurrently ()
 Indicates whether a game state can be loaded. More...
virtual Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 Save a game state. More...
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 Save a game state. More...
virtual bool canSaveGameStateCurrently ()
 Indicates whether a game state can be saved. 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)

Public Attributes

Common::String launchMe
Common::String launchNext
Common::String loadNow
Common::String gamePath
Timer _timer
const SludgeGameDescription_gameDescription
- Public Attributes inherited from Engine

Protected Member Functions

Common::Error run () override
 Init the engine and start its main loop. More...
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
virtual void pauseEngineIntern (bool pause)
 Actual implementation of pauseEngine by subclasses. More...

Private Attributes


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...
- 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...
- Protected Attributes inherited from Engine
const Common::String _targetName

Detailed Description

Definition at line 67 of file sludge.h.

Constructor & Destructor Documentation

◆ SludgeEngine()

Sludge::SludgeEngine::SludgeEngine ( OSystem syst,
const SludgeGameDescription gameDesc 

Definition at line 48 of file sludge.cpp.

◆ ~SludgeEngine()

Sludge::SludgeEngine::~SludgeEngine ( )

Definition at line 92 of file sludge.cpp.

Member Function Documentation

◆ getFeatures()

uint32 Sludge::SludgeEngine::getFeatures ( ) const

Definition at line 38 of file detection.cpp.

◆ getGameFile()

const char * Sludge::SludgeEngine::getGameFile ( ) const

Definition at line 40 of file detection.cpp.

◆ getGameId()

const char * Sludge::SludgeEngine::getGameId ( ) const

Definition at line 37 of file detection.cpp.

◆ getLanguage()

Common::Language Sludge::SludgeEngine::getLanguage ( ) const

Definition at line 39 of file detection.cpp.

◆ getLanguageID()

uint Sludge::SludgeEngine::getLanguageID ( ) const

Definition at line 36 of file detection.cpp.

◆ getOrigPixelFormat()

Graphics::PixelFormat * Sludge::SludgeEngine::getOrigPixelFormat ( ) const

Definition at line 46 of file sludge.cpp.

◆ getRandomSource()

Common::RandomSource* Sludge::SludgeEngine::getRandomSource ( ) const

Definition at line 106 of file sludge.h.

◆ getScreenPixelFormat()

Graphics::PixelFormat * Sludge::SludgeEngine::getScreenPixelFormat ( ) const

Definition at line 45 of file sludge.cpp.

◆ run()

Common::Error Sludge::SludgeEngine::run ( )

Init the engine and start its main loop.

returns kNoError on success, else an error code.

Implements Engine.

Definition at line 136 of file sludge.cpp.

Member Data Documentation

◆ _cursorMan

CursorManager* Sludge::SludgeEngine::_cursorMan

Definition at line 90 of file sludge.h.

◆ _evtMan

EventManager* Sludge::SludgeEngine::_evtMan

Definition at line 87 of file sludge.h.

◆ _fatalMan

FatalMsgManager* Sludge::SludgeEngine::_fatalMan

Definition at line 95 of file sludge.h.

◆ _floorMan

FloorManager* Sludge::SludgeEngine::_floorMan

Definition at line 94 of file sludge.h.

◆ _gameDescription

const SludgeGameDescription* Sludge::SludgeEngine::_gameDescription

Definition at line 110 of file sludge.h.

◆ _gfxMan

GraphicsManager* Sludge::SludgeEngine::_gfxMan

Definition at line 86 of file sludge.h.

◆ _languageMan

LanguageManager* Sludge::SludgeEngine::_languageMan

Definition at line 84 of file sludge.h.

◆ _objMan

ObjectManager* Sludge::SludgeEngine::_objMan

Definition at line 85 of file sludge.h.

◆ _origFormat

Graphics::PixelFormat* Sludge::SludgeEngine::_origFormat

Definition at line 115 of file sludge.h.

◆ _peopleMan

PeopleManager* Sludge::SludgeEngine::_peopleMan

Definition at line 93 of file sludge.h.

◆ _pixelFormat

Graphics::PixelFormat* Sludge::SludgeEngine::_pixelFormat

Definition at line 114 of file sludge.h.

◆ _regionMan

RegionManager* Sludge::SludgeEngine::_regionMan

Definition at line 92 of file sludge.h.

◆ _resMan

ResourceManager* Sludge::SludgeEngine::_resMan

Definition at line 83 of file sludge.h.

◆ _rnd

Common::RandomSource* Sludge::SludgeEngine::_rnd

Definition at line 113 of file sludge.h.

◆ _soundMan

SoundManager* Sludge::SludgeEngine::_soundMan

Definition at line 88 of file sludge.h.

◆ _speechMan

SpeechManager* Sludge::SludgeEngine::_speechMan

Definition at line 91 of file sludge.h.

◆ _timer

Timer Sludge::SludgeEngine::_timer

Definition at line 80 of file sludge.h.

◆ _txtMan

TextManager* Sludge::SludgeEngine::_txtMan

Definition at line 89 of file sludge.h.

◆ gamePath

Common::String Sludge::SludgeEngine::gamePath

Definition at line 77 of file sludge.h.

◆ launchMe

Common::String Sludge::SludgeEngine::launchMe

Definition at line 74 of file sludge.h.

◆ launchNext

Common::String Sludge::SludgeEngine::launchNext

Definition at line 75 of file sludge.h.

◆ loadNow

Common::String Sludge::SludgeEngine::loadNow

Definition at line 76 of file sludge.h.

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