Hadesch::HadeschEngine Class Reference

Inheritance diagram for Hadesch::HadeschEngine:

Public Member Functions
	HadeschEngine (OSystem *syst, const ADGameDescription *desc)
Common::Error	run () override
bool	hasFeature (EngineFeature f) const override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	loadGameStream (Common::SeekableReadStream *stream) override
Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
Common::SeekableReadStream *	openFile (const Common::String &name, bool addCurrentPath)
Common::RandomSource &	getRnd ()
const Common::String &	getCDScenesPath () const
Common::SharedPtr< VideoRoom >	getVideoRoom ()
void	moveToRoom (RoomId id)
void	handleEvent (EventHandlerWrapper event)
int32	getCurrentTime ()
Common::Point	getMousePos ()
void	addTimer (EventHandlerWrapper event, int period, int repeat=1)
void	addSkippableTimer (EventHandlerWrapper event, int period, int repeat=1)
void	cancelTimer (int eventId)
Common::SharedPtr< PodFile >	getWdPodFile ()
RoomId	getPreviousRoomId () const
bool	isRoomVisited (RoomId id) const
Persistent *	getPersistent ()
Common::SharedPtr< Handler >	getCurrentHandler ()
Common::SharedPtr< HeroBelt >	getHeroBelt ()
int	firstAvailableSlot ()
void	newGame ()
void	enterOptions ()
void	resetOptionsRoom ()
void	exitOptions ()
void	enterOptionsCredits ()
void	quit ()
bool	hasAnySaves ()
Common::Array< HadeschSaveDescriptor >	getHadeschSavesList ()
void	deleteSave (int slot)
int	genSubtitleID ()
uint32	getSubtitleDelayPerChar () const
void	wrapSubtitles (const Common::U32String &str, Common::Array< Common::U32String > &lines)
Common::U32String	translate (const Common::String &str)
void	fallbackClick ()
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
virtual bool	gameTypeHasAddOns () const
virtual bool	dirCanBeGameAddOn (const Common::FSDirectory &dir) const
virtual bool	dirMustBeGameAddOn (const Common::FSDirectory &dir) const
Common::ErrorCode	updateAddOns (const MetaEngine *metaEngine) 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	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 ()

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 bool	warnUserAboutUnsupportedGame (Common::String msg=Common::String())
static bool	warnUserAboutUnsupportedAddOn (Common::String addOnName)
static void	errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)
static void	errorUnsupportedGame (Common::String extraMsg)
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer
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()

Common::Error Hadesch::HadeschEngine::run ( )

overridevirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

hasFeature()

bool Hadesch::HadeschEngine::hasFeature ( EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool Hadesch::HadeschEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

canSaveGameStateCurrently()

bool Hadesch::HadeschEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

loadGameStream()

Common::Error Hadesch::HadeschEngine::loadGameStream ( Common::SeekableReadStream *  stream )

overridevirtual

Load a game state.

Parameters

stream

The stream to load the save state from.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

saveGameStream()

Common::Error Hadesch::HadeschEngine::saveGameStream ( Common::WriteStream *  stream, bool  isAutosave = false  )

overridevirtual

Save a game state.

Parameters

stream	The write stream to save the savegame data to.
isAutosave	Expected to be true if an autosave is being created.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

---

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

• engines/hadesch/hadesch.h