ScummVM API documentation
Hugo::HugoEngine Class Reference
Inheritance diagram for Hugo::HugoEngine:
Engine

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 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
 
StatusgetGameStatus ()
 
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 * getCopyrightString () const
 
Common::String getSaveStateName (int slot) const override
 
uint16 ** loadLongArray (Common::SeekableReadStream &in)
 
- Public Member Functions inherited from Engine
MetaEnginegetMetaEngine () const
 
void setMetaEngine (MetaEngine *metaEngine)
 
PauseToken pauseEngine ()
 
bool isPaused () const
 
void openMainMenuDialog ()
 
uint32 getTotalPlayTime () const
 
void setTotalPlayTime (uint32 time=0)
 
Common::TimerManagergetTimerManager ()
 
Common::EventManagergetEventManager ()
 
Common::SaveFileManagergetSaveFileManager ()
 
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::DebuggergetDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::DebuggergetOrCreateDebugger ()
 
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 HugoEngineget ()
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 
static bool shouldQuit ()
 
static MetaEngineDetectiongetMetaEngineDetection ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
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 _scoreLine
 
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
 

Member Function Documentation

◆ canLoadGameStateCurrently()

bool Hugo::HugoEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional 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
msgOptional 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
slotThe slot into which the save state should be stored.
descDescription for the save state, entered by the user.
isAutosaveExpected 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
slotThe 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: