Draci::DraciEngine Class Reference

Inheritance diagram for Draci::DraciEngine:

Public Member Functions
	DraciEngine (OSystem *syst, const ADGameDescription *gameDesc)
int	init ()
Common::Error	run () override
bool	hasFeature (Engine::EngineFeature f) const override
void	pauseEngineIntern (bool pause) override
void	syncSoundSettings () override
void	handleEvents ()
Common::String	getSaveStateName (int slot) const override
Common::Error	loadGameState (int slot) override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
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 ()
bool	enhancementEnabled (int32 cls)
virtual void	applyGameSettings ()
virtual void	flipMute ()
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 ()

Static Public Member Functions
static Common::String	getSavegameFile (int saveGameIdx)
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
Screen *	_screen
Mouse *	_mouse
Game *	_game
Script *	_script
AnimationManager *	_anims
Sound *	_sound
MusicPlayer *	_music
Font *	_smallFont
Font *	_bigFont
BArchive *	_iconsArchive
BArchive *	_objectsArchive
BArchive *	_spritesArchive
BArchive *	_paletteArchive
BArchive *	_roomsArchive
BArchive *	_overlaysArchive
BArchive *	_animationsArchive
BArchive *	_walkingMapsArchive
BArchive *	_itemsArchive
BArchive *	_itemImagesArchive
BArchive *	_initArchive
BArchive *	_stringsArchive
SoundArchive *	_soundsArchive
SoundArchive *	_dubbingArchive
bool	_showWalkingMap
Common::RandomSource	_rnd
int32	_pauseStartTime
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 }
Protected Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)
void	defaultSyncSoundSettings ()
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()

Common::Error Draci::DraciEngine::run ( )

overridevirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

hasFeature()

bool Draci::DraciEngine::hasFeature ( Engine::EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

pauseEngineIntern()

void Draci::DraciEngine::pauseEngineIntern ( bool  pause )

overridevirtual

Actual implementation of pauseEngine by subclasses.

See also

Engine::pauseEngine

Reimplemented from Engine.

syncSoundSettings()

void Draci::DraciEngine::syncSoundSettings ( )

overridevirtual

Notify the engine that the sound settings in the config manager might have changed and that it should adjust any internal volume (and other) values accordingly.

The default implementation sets the volume levels of all mixer sound types according to the config entries of the active domain. When overwriting, call the default implementation first, then adjust the volumes further (if required).

Note

When setting volume levels, respect the "mute" config entry.

The volume for the plain sound type is reset to the maximum volume. If the engine can associate its own value for this type, it needs to overwrite this member and set it accordingly.

Reimplemented from Engine.

getSaveStateName()

Common::String Draci::DraciEngine::getSaveStateName ( int  slot ) const

inlineoverridevirtual

Generate the savegame filename.

Reimplemented from Engine.

loadGameState()

Common::Error Draci::DraciEngine::loadGameState ( int  slot )

overridevirtual

Load a game state.

Parameters

slot	The slot from which a save state should be loaded.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool Draci::DraciEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

overridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

saveGameState()

Common::Error Draci::DraciEngine::saveGameState ( int  slot, const Common::String &  desc, bool  isAutosave = false  )

overridevirtual

Save a game state.

Parameters

slot	The slot into which the save state should be stored.
desc	Description for the save state, entered by the user.
isAutosave	Expected to be true if an autosave is being created.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

canSaveGameStateCurrently()

bool Draci::DraciEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

overridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

---

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

• engines/draci/draci.h