Hugo::HugoEngine Class Reference

Inheritance diagram for Hugo::HugoEngine:

Public Member Functions
	HugoEngine (OSystem *syst, const HugoGameDescription *gd)
uint32	getFeatures () const
const char *	getGameId () const
GameType	getGameType () const
Common::Platform	getPlatform () const
bool	isPacked () const
bool	useWindowsInterface () const
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
bool	loadHugoDat ()
int8	getTPS () const
void	initGame (const HugoGameDescription *gd)
void	initGamePart (const HugoGameDescription *gd)
void	endGame ()
void	gameOverMsg ()
void	initStatus ()
void	readScreenFiles (const int screen)
void	setNewScreen (const int screen)
void	shutdown ()
void	syncSoundSettings () override
Status &	getGameStatus ()
int	getScore () const
void	setScore (const int newScore)
void	adjustScore (const int adjustment)
int	getMaxScore () const
void	setMaxScore (const int newScore)
Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
Common::Error	loadGameState (int slot) override
bool	hasFeature (EngineFeature f) const override
const char *	getCopyrightString1 () const
const char *	getCopyrightString2 () const
Common::String	getSaveStateName (int slot) const override
uint16 **	loadLongArray (Common::SeekableReadStream &in)
Common::KeyCode	notifyBox (const Common::String &text, bool protect=false, TtsOptions ttsOptions=kTtsReplaceNewlines)
Common::String	promptBox (const Common::String &text)
bool	yesNoBox (const Common::String &text, bool useFirstKey)
void	takeObjectBox (const char *name)
void	sayText (const Common::String &text, Common::TextToSpeechManager::Action action=Common::TextToSpeechManager::INTERRUPT)
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	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 HugoEngine &	get ()
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
OSystem *	_system
byte	_numVariant
byte	_gameVariant
int8	_soundSilence
int8	_soundTest
int8	_tunesNbr
uint16	_numScreens
uint16	_numStates
int8	_normalTPS
Object *	_hero
byte *	_screenPtr
byte	_heroImage
byte *	_screenStates
Command	_line
Config	_config
int16 *	_defltTunes
uint16	_look
uint16	_take
uint16	_drop
Maze	_maze
hugoBoot	_boot
Common::RandomSource *	_rnd
const char *	_episode
Common::Path	_picDir
Command	_statusLine
Command	_promptLine
bool	_voiceScoreLine
bool	_voiceSoundSetting
bool	_queueAllVoicing
int	_previousScore
Common::String	_previousSaid
const HugoGameDescription *	_gameDescription
FileManager *	_file
Scheduler *	_scheduler
Screen *	_screen
MouseHandler *	_mouse
InventoryHandler *	_inventory
Parser *	_parser
Route *	_route
SoundHandler *	_sound
IntroHandler *	_intro
ObjectHandler *	_object
TextHandler *	_text
TopMenu *	_topMenu
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () 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 }
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

canLoadGameStateCurrently()

bool Hugo::HugoEngine::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 Hugo::HugoEngine::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.

syncSoundSettings()

void Hugo::HugoEngine::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.

saveGameState()

Common::Error Hugo::HugoEngine::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.

loadGameState()

Common::Error Hugo::HugoEngine::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.

hasFeature()

bool Hugo::HugoEngine::hasFeature ( EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

getSaveStateName()

Common::String Hugo::HugoEngine::getSaveStateName ( int  slot ) const

overridevirtual

Generate the savegame filename.

Reimplemented from Engine.

run()

Common::Error Hugo::HugoEngine::run ( )

overrideprotectedvirtual

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:

• engines/hugo/hugo.h