ScummVM API documentation
DM::DMEngine Class Reference
Inheritance diagram for DM::DMEngine:
Engine

Public Member Functions

 DMEngine (OSystem *syst, const DMADGameDescription *gameDesc)
 
bool hasFeature (EngineFeature f) const override
 
Common::Error loadGameState (int slot) override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool isDemo () const
 
void delay (uint16 verticalBlank)
 
uint16 getScaledProduct (uint16 val, uint16 scale, uint16 vale2)
 
uint16 getRandomNumber (uint32 max)
 
int16 ordinalToIndex (int16 val)
 
int16 indexToOrdinal (int16 val)
 
Common::Error run () override
 
void saveGame ()
 
LoadgameResult loadgame (int16 slot)
 
void endGame (bool doNotDrawCreditsOnly)
 
void entranceDrawCredits ()
 
void fuseSequence ()
 
Common::Language getGameLanguage ()
 
Direction turnDirRight (int16 dir)
 
Direction turnDirLeft (int16 dir)
 
Direction returnOppositeDir (int16 dir)
 
bool isOrientedWestEast (int16 dir)
 
uint16 normalizeModulo4 (int16 dir)
 
int32 filterTime (int32 mapTime)
 
int32 setMapAndTime (uint32 map, uint32 time)
 
uint16 getMap (int32 mapTime)
 
Thing thingWithNewCell (Thing thing, int16 cell)
 
int16 getDistance (int16 mapx1, int16 mapy1, int16 mapx2, int16 mapy2)
 
int32 setMap (int32 mapTime, uint32 map)
 
- 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 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::DebuggergetDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::DebuggergetOrCreateDebugger ()
 
virtual void syncSoundSettings ()
 
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 saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
virtual bool canSaveGameStateCurrently (Common::U32String *msg=nullptr)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

Console_console
 
DisplayMan_displayMan
 
DungeonMan_dungeonMan
 
EventManager_eventMan
 
MenuMan_menuMan
 
ChampionMan_championMan
 
ObjectMan_objectMan
 
InventoryMan_inventoryMan
 
TextMan_textMan
 
MovesensMan_moveSens
 
GroupMan_groupMan
 
Timeline_timeline
 
ProjExpl_projexpl
 
DialogMan_dialog
 
SoundMan_sound
 
Common::MemoryWriteStreamDynamic_saveThumbnail
 
bool _engineShouldQuit
 
int _loadSaveSlotAtRuntime
 
GameMode _gameMode
 
bool _restartGameRequest
 
bool _stopWaitingForPlayerInput
 
bool _gameTimeTicking
 
bool _restartGameAllowed
 
bool _pressingEye
 
bool _stopPressingEye
 
bool _pressingMouth
 
bool _stopPressingMouth
 
bool _highlightBoxInversionRequested
 
int16 _projectileDisableMovementTicks
 
int16 _lastProjectileDisabledMovementDirection
 
bool _gameWon
 
int16 _newPartyMapIndex
 
bool _setMousePointerToObjectInMainLoop
 
int16 _disabledMovementTicks
 
int8 _dirIntoStepCountEast [4]
 
int8 _dirIntoStepCountNorth [4]
 
int32 _gameTime
 
char _stringBuildBuffer [128]
 
int16 _waitForInputMaxVerticalBlankCount
 
Thing _thingNone
 
Thing _thingEndOfList
 
Thing _thingFirstExplosion
 
Thing _thingExplFireBall
 
Thing _thingExplSlime
 
Thing _thingExplLightningBolt
 
Thing _thingExplHarmNonMaterial
 
Thing _thingExplOpenDoor
 
Thing _thingExplPoisonBolt
 
Thing _thingExplPoisonCloud
 
Thing _thingExplSmoke
 
Thing _thingExplFluxcage
 
Thing _thingExplRebirthStep1
 
Thing _thingExplRebirthStep2
 
Thing _thingParty
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

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 MetaEngineDetectiongetMetaEngineDetection ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 
- 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
 

Member Function Documentation

◆ hasFeature()

bool DM::DMEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ loadGameState()

Common::Error DM::DMEngine::loadGameState ( int  slot)
overridevirtual

Load a game state.

Parameters
slotThe slot from which a save state should be loaded.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool DM::DMEngine::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.

◆ run()

Common::Error DM::DMEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.


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