ScummVM API documentation
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
MADS::MADSEngine Class Reference
Inheritance diagram for MADS::MADSEngine:
Engine

Public Member Functions

 MADSEngine (OSystem *syst, const MADSGameDescription *gameDesc)
 
uint32 getFeatures () const
 
Common::Language getLanguage () const
 
Common::Platform getPlatform () const
 
uint16 getVersion () const
 
uint32 getGameID () const
 
uint32 getGameFeatures () const
 
bool isDemo () const
 
int getRandomNumber (int maxNumber)
 
int getRandomNumber (int minNumber, int maxNumber)
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
void syncSoundSettings () override
 
void saveOptions ()
 
- Public Member Functions inherited from Engine
MetaEngine * getMetaEngine () const
 
void setMetaEngine (MetaEngine *metaEngine)
 
PauseToken pauseEngine ()
 
bool isPaused () const
 
void openMainMenuDialog ()
 
uint32 getTotalPlayTime () const
 
void setTotalPlayTime (uint32 time=0)
 
Common::TimerManager * getTimerManager ()
 
Common::EventManager * getEventManager ()
 
Common::SaveFileManager * getSaveFileManager ()
 
bool existExtractedCDAudioFiles (uint track=1)
 
bool isDataAndCDAudioReadFromSameCD ()
 
void warnMissingExtractedCDAudio ()
 
void handleAutoSave ()
 
void saveAutosaveIfEnabled ()
 
virtual bool canSaveAutosaveCurrently ()
 
virtual int getAutosaveSlot () const
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
virtual void initializePath (const Common::FSNode &gamePath)
 
virtual void errorString (const char *buf_input, char *buf_output, int buf_output_size)
 
virtual GUI::Debugger * getDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::Debugger * getOrCreateDebugger ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
virtual Common::Error loadGameStream (Common::SeekableReadStream *stream)
 
void setGameToLoadSlot (int slot)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

Debugger * _debugger
 
Dialogs * _dialogs
 
EventsManager * _events
 
Font * _font
 
Game * _game
 
GameConversations * _gameConv
 
Palette * _palette
 
Resources * _resources
 
Screen * _screen
 
SoundManager * _sound
 
AudioPlayer * _audio
 
bool _easyMouse
 
bool _invObjectsAnimated
 
bool _textWindowStill
 
ScreenFade _screenFade
 
bool _musicFlag
 
bool _soundFlag
 
bool _dithering
 
bool _disableFastwalk
 
- Public Attributes inherited from Engine
OSystem * _system
 
Audio::Mixer * _mixer
 

Protected Member Functions

Common::Error run () override
 
bool hasFeature (EngineFeature f) const override
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 
virtual void pauseEngineIntern (bool pause)
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 
static bool shouldQuit ()
 
static MetaEngineDetection & getMetaEngineDetection ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 
- Protected Attributes inherited from Engine
Common::TimerManager * _timer
 
Common::EventManager * _eventMan
 
Common::SaveFileManager * _saveFileMan
 
GUI::Dialog * _mainMenuDialog
 
const Common::String _targetName
 

Member Function Documentation

◆ run()

Common::Error MADS::MADSEngine::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool MADS::MADSEngine::hasFeature ( EngineFeature  f) const
overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool MADS::MADSEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr)
overridevirtual

Returns true if it is currently okay to restore a game

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool MADS::MADSEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr)
overridevirtual

Returns true if it is currently okay to save the game

Reimplemented from Engine.

◆ loadGameState()

Common::Error MADS::MADSEngine::loadGameState ( int  slot)
overridevirtual

Handles loading a game via the GMM

Reimplemented from Engine.

◆ saveGameState()

Common::Error MADS::MADSEngine::saveGameState ( int  slot,
const Common::String &  desc,
bool  isAutosave = false 
)
overridevirtual

Handles saving the game via the GMM

Reimplemented from Engine.

◆ syncSoundSettings()

void MADS::MADSEngine::syncSoundSettings ( )
overridevirtual

Handles updating sound settings after they're changed in the GMM dialog

Reimplemented from Engine.

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