ScummVM API documentation
Public Member Functions | Public Attributes | List of all members
Ultima::Shared::UltimaEarlyEngine Class Reference
Inheritance diagram for Ultima::Shared::UltimaEarlyEngine:
Ultima::Shared::UltimaEngine Ultima::Shared::EventsCallback Engine

Public Member Functions

 UltimaEarlyEngine (OSystem *syst, const UltimaGameDescription *gameDesc)
 
Common::Error run () override
 
void playGame ()
 
Graphics::Screen * getScreen () const override
 
bool canLoadGameStateCurrently (bool isAutosave) override
 
bool canSaveGameStateCurrently (bool isAutosave) override
 
Common::Error loadGameStream (Common::SeekableReadStream *stream) override
 
Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
 
Game * createGame () const
 
- Public Member Functions inherited from Ultima::Shared::UltimaEngine
 UltimaEngine (OSystem *syst, const Ultima::UltimaGameDescription *gameDesc)
 
bool hasFeature (EngineFeature f) const override
 
uint32 getFeatures () const
 
Common::Language getLanguage () const
 
GameId getGameId () const
 
bool isEnhanced () const
 
void GUIError (const Common::U32String &msg)
 
uint getRandomNumber (uint maxVal)
 
uint getRandomNumber (uint min, uint max)
 
Common::FSNode getGameDirectory () const
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
- 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 initializePath (const Common::FSNode &gamePath)
 
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 syncSoundSettings ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
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 Member Functions inherited from Ultima::Shared::EventsCallback
virtual ~EventsCallback ()
 

Public Attributes

GameBase * _game
 
MouseCursor * _mouseCursor
 
Gfx::Screen * _screen
 
EventsManager * _events
 
- 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 MetaEngineDetection & getMetaEngineDetection ()
 
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 Ultima::Shared::UltimaEngine
const UltimaGameDescription * _gameDescription
 
Common::Archive * _dataArchive
 
- 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 Ultima::Shared::UltimaEarlyEngine::run ( )
overridevirtual

Main method for running the game

Implements Engine.

◆ playGame()

void Ultima::Shared::UltimaEarlyEngine::playGame ( )

Play the game

◆ getScreen()

Graphics::Screen* Ultima::Shared::UltimaEarlyEngine::getScreen ( ) const
overridevirtual

Get the screen

Reimplemented from Ultima::Shared::EventsCallback.

◆ canLoadGameStateCurrently()

bool Ultima::Shared::UltimaEarlyEngine::canLoadGameStateCurrently ( bool  isAutosave)
overridevirtual

Indicates whether a game state can be loaded.

Parameters
isAutosaveFlags whether it's an autosave check

Implements Ultima::Shared::UltimaEngine.

◆ canSaveGameStateCurrently()

bool Ultima::Shared::UltimaEarlyEngine::canSaveGameStateCurrently ( bool  isAutosave)
overridevirtual

Indicates whether a game state can be saved.

Parameters
isAutosaveFlags whether it's an autosave check

Implements Ultima::Shared::UltimaEngine.

◆ loadGameStream()

Common::Error Ultima::Shared::UltimaEarlyEngine::loadGameStream ( Common::SeekableReadStream *  stream)
overridevirtual

Load a savegame

Reimplemented from Engine.

◆ saveGameStream()

Common::Error Ultima::Shared::UltimaEarlyEngine::saveGameStream ( Common::WriteStream *  stream,
bool  isAutosave = false 
)
overridevirtual

Save a game state.

Reimplemented from Engine.

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