ScummVM API documentation
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Titanic::TitanicEngine Class Reference
Inheritance diagram for Titanic::TitanicEngine:
Engine

Public Member Functions

 TitanicEngine (OSystem *syst, const TitanicGameDescription *gameDesc)
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
void syncSoundSettings () override
 
uint32 getFeatures () const
 
Common::Language getLanguage () const
 
bool isGerman () const
 
uint getRandomNumber (uint max)
 
double getRandomFloat ()
 
CString getSavegameName (int slot)
 
- 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
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
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 ()
 
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

Events * _events
 
CFilesManager * _filesManager
 
CMovieManager _movieManager
 
Graphics::Screen * _screen
 
OSScreenManager * _screenManager
 
CMainGameWindow * _window
 
Common::RandomSource _randomSource
 
CScriptHandler * _scriptHandler
 
TTscriptBase * _script
 
CTrueTalkManager * _trueTalkManager
 
CExeResources _exeResources
 
StringArray _itemNames
 
StringArray _itemDescriptions
 
StringArray _itemIds
 
StringArray _roomNames
 
Strings _strings
 
CString _stateRoomExitView
 
int _loadSaveSlot
 
- Public Attributes inherited from Engine
OSystem * _system
 
Audio::Mixer * _mixer
 

Protected Member Functions

void initializePath (const Common::FSNode &gamePath) override
 
Common::Error run () override
 
bool hasFeature (EngineFeature f) const override
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 
virtual void pauseEngineIntern (bool pause)
 

Protected Attributes

const TitanicGameDescription * _gameDescription
 
- Protected Attributes inherited from Engine
Common::TimerManager * _timer
 
Common::EventManager * _eventMan
 
Common::SaveFileManager * _saveFileMan
 
GUI::Dialog * _mainMenuDialog
 
const Common::String _targetName
 

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

Member Function Documentation

◆ initializePath()

void Titanic::TitanicEngine::initializePath ( const Common::FSNode &  gamePath)
overrideprotectedvirtual

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 Titanic::TitanicEngine::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Titanic::TitanicEngine::hasFeature ( EngineFeature  f) const
overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Titanic::TitanicEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr)
overridevirtual

Returns true if a savegame can be loaded

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Titanic::TitanicEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr)
overridevirtual

Returns true if the game can be saved

Reimplemented from Engine.

◆ loadGameState()

Common::Error Titanic::TitanicEngine::loadGameState ( int  slot)
overridevirtual

Called by the GMM to load a savegame

Reimplemented from Engine.

◆ saveGameState()

Common::Error Titanic::TitanicEngine::saveGameState ( int  slot,
const Common::String &  desc,
bool  isAutosave = false 
)
overridevirtual

Called by the GMM to save the game

Reimplemented from Engine.

◆ syncSoundSettings()

void Titanic::TitanicEngine::syncSoundSettings ( )
overridevirtual

Handles updates to the sound levels

Reimplemented from Engine.

◆ getFeatures()

uint32 Titanic::TitanicEngine::getFeatures ( ) const

Gets the game features

◆ getLanguage()

Common::Language Titanic::TitanicEngine::getLanguage ( ) const

Returns the language for the game

◆ isGerman()

bool Titanic::TitanicEngine::isGerman ( ) const
inline

Returns true if it's the German version

◆ getRandomNumber()

uint Titanic::TitanicEngine::getRandomNumber ( uint  max)
inline

Returns a uniform random unsigned integer in the interval [0, max]

◆ getRandomFloat()

double Titanic::TitanicEngine::getRandomFloat ( )
inline

Returns a uniform random floating point number in the interval [0.0, 65535.0]

◆ getSavegameName()

CString Titanic::TitanicEngine::getSavegameName ( int  slot)

Checks whether a savegame exists for the given slot, and if it exists, returns it's description

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