ScummVM API documentation
Buried::BuriedEngine Class Reference
Inheritance diagram for Buried::BuriedEngine:
Engine

Public Member Functions

 BuriedEngine (OSystem *syst, const ADGameDescription *gamedesc)
 
bool isDemo () const
 
bool isTrial () const
 
bool isTrueColor () const
 
bool isWin95 () const
 
bool isCompressed () const
 
Common::Path getEXEName () const
 
Common::Path getLibraryName () const
 
Common::Language getLanguage () const
 
bool hasFeature (EngineFeature f) const override
 
void pauseEngineIntern (bool pause) override
 
Common::String getString (uint32 stringID)
 
Common::Path getFilePath (uint32 stringID)
 
Common::Path getFilePath (int timeZone, int environment, int fileOffset)
 
Graphics::WinCursorGroupgetCursorGroup (uint32 cursorGroupID)
 
Common::SeekableReadStreamgetBitmapStream (uint32 bitmapID)
 
Common::SeekableReadStreamgetNavData (uint32 resourceID)
 
Common::SeekableReadStreamgetSndData (uint32 resourceID)
 
Common::SeekableReadStreamgetAnimData (uint32 resourceID)
 
Common::SeekableReadStreamgetAIData (uint32 resourceID)
 
Common::SeekableReadStreamgetItemData (uint32 resourceID)
 
Common::SeekableReadStreamgetBookData (uint32 resourceID)
 
Common::SeekableReadStreamgetFileBCData (uint32 resourceID)
 
Common::SeekableReadStreamgetINNData (uint32 resourceID)
 
uint32 getVersion ()
 
uint32 computeNavDBResourceID (int timeZone, int environment)
 
uint32 computeAnimDBResourceID (int timeZone, int environment)
 
uint32 computeAIDBResourceID (int timeZone, int environment)
 
uint32 computeFileNameResourceID (int timeZone, int environment, int fileOffset)
 
uint createTimer (Window *window, uint period)
 
bool killTimer (uint timer)
 
void removeAllTimers (Window *window)
 
void addVideo (VideoWindow *window)
 
void removeVideo (VideoWindow *window)
 
void updateVideos ()
 
void postMessageToWindow (Window *dest, Message *message)
 
void sendAllMessages ()
 
void processAudioVideoSkipMessages (VideoWindow *video, int soundId)
 
void removeKeyboardMessages (Window *window)
 
void removeMouseMessages (Window *window)
 
void removeAllMessages (Window *window)
 
void removeMessages (Window *window, int messageBegin, int messageEnd)
 
bool hasMessage (Window *window, int messageBegin, int messageEnd) const
 
void yield (VideoWindow *video, int soundId)
 
int getTransitionSpeed ()
 
void setTransitionSpeed (int newSpeed)
 
void releaseCapture ()
 
bool runQuitDialog ()
 
bool isControlDown () const
 
void pauseGame ()
 
void showPoints ()
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::String getSaveStateName (int slot) const override
 
Common::Error loadGameStream (Common::SeekableReadStream *stream) override
 
Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
 
void handleSaveDialog ()
 
void handleRestoreDialog ()
 
- 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 syncSoundSettings ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::Error loadGameState (int slot)
 
void setGameToLoadSlot (int slot)
 
virtual Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

const ADGameDescription_gameDescription
 
GraphicsManager_gfx
 
SoundManager_sound
 
Window_mainWindow
 
Window_focusedWindow
 
Window_captureWindow
 
- 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 ()
 

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 Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 

Member Function Documentation

◆ run()

Common::Error Buried::BuriedEngine::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Buried::BuriedEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ pauseEngineIntern()

void Buried::BuriedEngine::pauseEngineIntern ( bool  pause)
overridevirtual

Actual implementation of pauseEngine by subclasses.

See also
Engine::pauseEngine

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Buried::BuriedEngine::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 Buried::BuriedEngine::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.

◆ getSaveStateName()

Common::String Buried::BuriedEngine::getSaveStateName ( int  slot) const
inlineoverridevirtual

Generate the savegame filename.

Reimplemented from Engine.

◆ loadGameStream()

Common::Error Buried::BuriedEngine::loadGameStream ( Common::SeekableReadStream stream)
overridevirtual

Load a game state.

Parameters
streamThe stream to load the save state from.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ saveGameStream()

Common::Error Buried::BuriedEngine::saveGameStream ( Common::WriteStream stream,
bool  isAutosave = false 
)
overridevirtual

Save a game state.

Parameters
streamThe write stream to save the savegame data to.
isAutosaveExpected to be true if an autosave is being created.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.


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