ScummVM API documentation
Dgds::DgdsEngine Class Reference
Inheritance diagram for Dgds::DgdsEngine:
Engine

Public Member Functions

 DgdsEngine (OSystem *syst, const ADGameDescription *gameDesc)
 
virtual Common::Error run () override
 
void restartGame ()
 
DgdsGameId getGameId () const
 
Common::Language getGameLang () const
 
Common::Platform getPlatform () const
 
Graphics::ManagedSurfacegetBackgroundBuffer ()
 
Graphics::ManagedSurfacegetStoredAreaBuffer ()
 
Common::SeekableReadStreamgetResource (const Common::String &name, bool ignorePatches)
 
ResourceManagergetResourceManager ()
 
DecompressorgetDecompressor ()
 
const SDSScenegetScene () const
 
SDSScenegetScene ()
 
GDSScenegetGDSScene ()
 
const FontManagergetFontMan () const
 
const Common::SharedPtr< Image > & getUICorners ()
 
const Common::SharedPtr< Image > & getIcons ()
 
GamePalettesgetGamePals ()
 
GlobalsgetGameGlobals ()
 
InventorygetInventory ()
 
ClockgetClock ()
 
ADSInterpreteradsInterpreter ()
 
Common::RandomSourcegetRandom ()
 
bool changeScene (int sceneNum)
 
void setMouseCursor (int num)
 
int getTextSpeed () const
 
void setTextSpeed (int16 speed)
 
int16 getDifficulty () const
 
void setDifficulty (int16 difficulty)
 
DgdsDetailLevel getDetailLevel () const
 
void setDetailLevel (DgdsDetailLevel level)
 
void setShowClock (bool val)
 
bool justChangedScene1 () const
 
bool justChangedScene2 () const
 
Common::Point getLastMouse () const
 
Common::Point getLastMouseMinusHot () const
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveAutosaveCurrently () override
 
Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
 
Common::Error loadGameStream (Common::SeekableReadStream *stream) override
 
bool hasFeature (EngineFeature f) const override
 
void setBackgroundFile (const Common::String &name)
 
const Common::StringgetBackgroundFile () const
 
void setMenuToTrigger (MenuId menu)
 
bool isInvButtonVisible () const
 
ShellGamegetShellGame ()
 
HocIntrogetHocIntro ()
 
ChinaTraingetChinaTrain ()
 
ChinaTankgetChinaTank ()
 
DragonArcadegetDragonArcade ()
 
void setSkipNextFrame ()
 
uint32 getThisFrameMs () const
 
void setFlipMode (bool mode)
 
bool isEGA () const
 
void enableKeymapper ()
 
void disableKeymapper ()
 
- Public Member Functions inherited from Engine
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 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::DebuggergetDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::DebuggergetOrCreateDebugger ()
 
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)
 
void setGameToLoadSlot (int slot)
 
virtual Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Static Public Member Functions

static DgdsEnginegetInstance ()
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 
static bool shouldQuit ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 

Public Attributes

Common::Platform _platform
 
Common::Language _gameLang
 
Sound_soundPlayer
 
Graphics::ManagedSurface _compositionBuffer
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Static Public Attributes

static const byte HOC_CHAR_SWAP_ICONS []
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 
virtual void pauseEngineIntern (bool pause)
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Member Function Documentation

◆ run()

virtual Common::Error Dgds::DgdsEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ canLoadGameStateCurrently()

bool Dgds::DgdsEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Dgds::DgdsEngine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveAutosaveCurrently()

bool Dgds::DgdsEngine::canSaveAutosaveCurrently ( )
overridevirtual

Indicate whether an autosave can currently be done.

Reimplemented from Engine.

◆ saveGameStream()

Common::Error Dgds::DgdsEngine::saveGameStream ( Common::WriteStream stream,
bool  isAutosave = false 
)
inlineoverridevirtual

Save a game state.

Parameters
streamThe write stream to save the savegame data to.
isAutosaveExpected to be true if an autosave is being created.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ loadGameStream()

Common::Error Dgds::DgdsEngine::loadGameStream ( Common::SeekableReadStream stream)
inlineoverridevirtual

Load a game state.

Parameters
streamThe stream to load the save state from.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ hasFeature()

bool Dgds::DgdsEngine::hasFeature ( EngineFeature  f) const
inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.


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