Hopkins::HopkinsEngine Class Reference

Inheritance diagram for Hopkins::HopkinsEngine:

Public Member Functions
	HopkinsEngine (OSystem *syst, const HopkinsGameDescription *gameDesc)
void	GUIError (const Common::String &msg)
uint32	getFeatures () const
Common::Language	getLanguage () const
Common::Platform	getPlatform () const
uint16	getVersion () const
bool	getIsDemo () const
const Common::String &	getTargetName () const
int	getRandomNumber (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	playIntro ()
void	syncSoundSettings () 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 ()
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
AnimationManager *	_animMan
ComputerManager *	_computer
DialogsManager *	_dialog
EventsManager *	_events
FileManager *	_fileIO
FontManager *	_fontMan
Globals *	_globals
GraphicsManager *	_graphicsMan
LinesManager *	_linesMan
MenuManager *	_menuMan
ObjectsManager *	_objectsMan
SaveLoadManager *	_saveLoad
ScriptManager *	_script
SoundManager *	_soundMan
TalkManager *	_talkMan
int	_startGameSlot
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 Hopkins::HopkinsEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

hasFeature()

bool Hopkins::HopkinsEngine::hasFeature ( EngineFeature  f ) const

overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool Hopkins::HopkinsEngine::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.

canSaveGameStateCurrently()

bool Hopkins::HopkinsEngine::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.

loadGameState()

Common::Error Hopkins::HopkinsEngine::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.

saveGameState()

Common::Error Hopkins::HopkinsEngine::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.

playIntro()

void Hopkins::HopkinsEngine::playIntro

(

)

Run the introduction sequence

syncSoundSettings()

void Hopkins::HopkinsEngine::syncSoundSettings ( )

overridevirtual

Synchronizes the sound settings from ScummVM into the engine

Reimplemented from Engine.

---

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

• engines/hopkins/hopkins.h