ScummVM API documentation
HDB::HDBGame Class Reference
Inheritance diagram for HDB::HDBGame:
Engine

Public Member Functions

 HDBGame (OSystem *syst, const ADGameDescription *gameDesc)
 
bool hasFeature (Engine::EngineFeature f) const override
 
void initializePath (const Common::FSNode &gamePath) override
 
Common::Error run () override
 
void syncSoundSettings () override
 
const char * getGameId () const
 
const char * getGameFile () const
 
uint32 getGameFlags () const
 
Common::Platform getPlatform () const
 
bool isDemo () const
 
bool isPPC () const
 
bool isHandango () const
 
bool init ()
 
void save (Common::OutSaveFile *out)
 
void loadSaveFile (Common::InSaveFile *in)
 
void start ()
 
bool restartMap ()
 
bool startMap (const char *name)
 
void changeMap (const char *name)
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
Common::Error loadGameState (int slot) override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
void saveGame (Common::OutSaveFile *out)
 
void loadGame (Common::InSaveFile *in)
 
Common::String genSaveFileName (uint slot, bool lua)
 
void saveWhenReady (int slot)
 
void loadWhenReady (int slot)
 
void setGameState (GameState gs)
 
GameState getGameState ()
 
void changeGameState ()
 
void paint ()
 
void moveMap (int x, int y)
 
void startMoveMap (int x, int y)
 
void setTargetXY (int x, int y)
 
void useEntity (AIEntity *e)
 
void setupProgressBar (int maxCount)
 
void drawProgressBar ()
 
void makeProgress ()
 
void checkProgress ()
 
void stopProgress ()
 
void drawLoadingScreen ()
 
int getActionMode ()
 
void setActionMode (int status)
 
void togglePause ()
 
bool getPause ()
 
void resetTimer ()
 
uint32 getTime ()
 
uint32 getTimeSlice ()
 
uint32 getTimeSliceDelta ()
 
const Common::StringgetTargetName ()
 
int getDebug ()
 
void setDebug (int flag)
 
bool isVoiceless ()
 
char * lastMapName ()
 
char * currentMapName ()
 
char * getInMapName ()
 
void setInMapName (const char *name)
 
void changeLevel (const char *name)
 
int32 getStarsMonkeystone7 ()
 
int32 getStarsMonkeystone14 ()
 
int32 getStarsMonkeystone21 ()
 
void setStarsMonkeystone7 (int32 value)
 
void setStarsMonkeystone14 (int32 value)
 
void setStarsMonkeystone21 (int32 value)
 
void setCheatingOn ()
 
bool getCheatingOn ()
 
- 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 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::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

const ADGameDescription_gameDescription
 
int _screenWidth
 
int _screenHeight
 
int _screenDrawWidth
 
int _screenDrawHeight
 
int _progressY
 
FileMan_fileMan
 
Gfx_gfx
 
LuaScript_lua
 
Map_map
 
AI_ai
 
Input_input
 
Menu_menu
 
Sound_sound
 
Window_window
 
Common::RandomSource_rnd
 
Save _saveHeader
 
bool _gameShutdown
 
Graphics::PixelFormat _format
 
Picture_progressGfx
 
Picture_progressMarkGfx
 
Picture_loadingScreenGfx
 
Picture_logoGfx
 
bool _progressActive
 
int _progressCurrent
 
int _progressXOffset
 
int _progressMax
 
Common::Array< uint32 > _frames
 
Common::OutSaveFile_currentOutSaveFile
 
Common::InSaveFile_currentInSaveFile
 
bool active
 
int slot
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

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 MetaEngineDetectiongetMetaEngineDetection ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 
- 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
 

Member Function Documentation

◆ hasFeature()

bool HDB::HDBGame::hasFeature ( Engine::EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ initializePath()

void HDB::HDBGame::initializePath ( const Common::FSNode gamePath)
overridevirtual

Initialize SearchMan according to the game path.

By default, this adds the directory in non-flat mode with a depth of 4 as priority 0 to SearchMan.

Parameters
gamePathThe base directory of the game data.

Reimplemented from Engine.

◆ run()

Common::Error HDB::HDBGame::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ syncSoundSettings()

void HDB::HDBGame::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 HDB::HDBGame::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 HDB::HDBGame::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.

◆ canLoadGameStateCurrently()

bool HDB::HDBGame::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 HDB::HDBGame::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.


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