Hpl1::Hpl1Engine Class Reference

Inheritance diagram for Hpl1::Hpl1Engine:

Public Member Functions
	Hpl1Engine (OSystem *syst, const ADGameDescription *gameDesc)
uint32	getFeatures () const
Common::String	getGameId () const
uint32	getRandomNumber (uint maxNum)
bool	hasFeature (EngineFeature f) const override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
Common::String	createSaveFile (const Common::String &internalName)
Common::String	mapInternalSaveToFile (const Common::String &internalName)
void	removeSaveFile (const Common::String &internalName)
Common::StringArray	listInternalSaves (const Common::String &pattern)
Common::Error	loadGameState (int slot) override
Common::Error	syncGame (Common::Serializer &s)
Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
Common::Error	loadGameStream (Common::SeekableReadStream *stream) 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
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
void	setGameToLoadSlot (int slot)
virtual Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
virtual bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr)
bool	saveGameDialog ()
bool	loadGameDialog ()

Public Attributes
Graphics::Screen *	_screen = nullptr
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override
void	pauseEngineIntern (bool pause) override
Protected Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)
void	defaultSyncSoundSettings ()

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	warnUserAboutTestingMode ()
static void	errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)
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
int32	_activeEnhancements = kEnhGameBreakingBugFixes

Member Function Documentation

run()

Common::Error Hpl1::Hpl1Engine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

pauseEngineIntern()

void Hpl1::Hpl1Engine::pauseEngineIntern ( bool  pause )

overrideprotectedvirtual

Actual implementation of pauseEngine by subclasses.

See also

Engine::pauseEngine

Reimplemented from Engine.

getGameId()

Common::String Hpl1::Hpl1Engine::getGameId

(

)

const

Returns the game Id

getRandomNumber()

uint32 Hpl1::Hpl1Engine::getRandomNumber ( uint  maxNum )

inline

Gets a random number

hasFeature()

bool Hpl1::Hpl1Engine::hasFeature ( EngineFeature  f ) const

inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool Hpl1::Hpl1Engine::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.

loadGameState()

Common::Error Hpl1::Hpl1Engine::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.

syncGame()

Common::Error Hpl1::Hpl1Engine::syncGame

(

Common::Serializer &

s

)

Uses a serializer to allow implementing savegame loading and saving using a single method

saveGameStream()

Common::Error Hpl1::Hpl1Engine::saveGameStream ( Common::WriteStream *  stream, bool  isAutosave = false  )

inlineoverridevirtual

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.

loadGameStream()

Common::Error Hpl1::Hpl1Engine::loadGameStream ( Common::SeekableReadStream *  stream )

inlineoverridevirtual

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.

---

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

• engines/hpl1/hpl1.h