ScummVM API documentation
Bagel::BagelEngine Class Reference
Inheritance diagram for Bagel::BagelEngine:
Engine Bagel::SpaceBar::SpaceBarEngine

Public Member Functions

 BagelEngine (OSystem *syst, const ADGameDescription *gameDesc)
 
uint32 getFeatures () const
 
Common::String getGameId () const
 
Common::Platform getPlatform () const
 
bool isDemo () const
 
uint32 getRandomNumber (uint maxNum=0x7fffffff)
 
bool hasFeature (EngineFeature f) const override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave, StBagelSave &saveData)
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
 
Common::Error loadGameStream (Common::SeekableReadStream *stream) override
 
SaveStateList listSaves () const
 
bool savesExist () const
 
void pauseEngineIntern (bool pause) override
 
void errorDialog (const char *msg) const
 
void enableKeymapper (bool enabled)
 
- 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 Common::Error run ()=0
 
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 syncSoundSettings ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
void setGameToLoadSlot (int slot)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

Graphics::Screen_screen = nullptr
 
MusicPlayer_midi = nullptr
 
bool _useOriginalSaveLoad = false
 
CBagMasterWin_masterWin = nullptr
 
CBofPoint g_cInitLoc
 
bool g_bUseInitLoc = false
 
bool g_getVilVarsFl = true
 
- 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 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 ()
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 

Member Function Documentation

◆ getGameId()

Common::String Bagel::BagelEngine::getGameId ( ) const

Returns the game Id

◆ getPlatform()

Common::Platform Bagel::BagelEngine::getPlatform ( ) const

Return the game's platform

◆ isDemo()

bool Bagel::BagelEngine::isDemo ( ) const

Return whether it's a demo

◆ getRandomNumber()

uint32 Bagel::BagelEngine::getRandomNumber ( uint  maxNum = 0x7fffffff)
inline

Gets a random number

◆ hasFeature()

bool Bagel::BagelEngine::hasFeature ( EngineFeature  f) const
inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Bagel::BagelEngine::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 Bagel::BagelEngine::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.

◆ saveGameState()

Common::Error Bagel::BagelEngine::saveGameState ( int  slot,
const Common::String desc,
bool  isAutosave = false 
)
overridevirtual

Save a game state

Reimplemented from Engine.

◆ loadGameState()

Common::Error Bagel::BagelEngine::loadGameState ( int  slot)
overridevirtual

Load a game state

Reimplemented from Engine.

◆ saveGameStream()

Common::Error Bagel::BagelEngine::saveGameStream ( Common::WriteStream stream,
bool  isAutosave = false 
)
overridevirtual

Handles saving the game

Reimplemented from Engine.

◆ loadGameStream()

Common::Error Bagel::BagelEngine::loadGameStream ( Common::SeekableReadStream stream)
overridevirtual

Handles loading a savegame

Reimplemented from Engine.

◆ listSaves()

SaveStateList Bagel::BagelEngine::listSaves ( ) const

Returns a list of savegames

◆ savesExist()

bool Bagel::BagelEngine::savesExist ( ) const

Returns true if any savegames exist

◆ pauseEngineIntern()

void Bagel::BagelEngine::pauseEngineIntern ( bool  pause)
overridevirtual

Pause all internal timers.

Reimplemented from Engine.


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