ScummVM API documentation
Ultima::Nuvie::NuvieEngine Class Reference
Inheritance diagram for Ultima::Nuvie::NuvieEngine:
Ultima::Shared::UltimaEngine Ultima::Shared::EventsCallback Engine

Public Member Functions

 NuvieEngine (OSystem *syst, const Ultima::UltimaGameDescription *gameDesc)
 
Common::Error run () override
 
void syncSoundSettings () override
 
bool canLoadGameStateCurrently (bool isAutosave) override
 
bool canSaveGameStateCurrently (bool isAutosave) override
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave) override
 
bool journeyOnwards ()
 
bool loadLatestSave ()
 
bool quickSave (int saveSlot, bool isLoad)
 
SoundManagergetSoundManager () 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
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 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 Member Functions inherited from Ultima::Shared::EventsCallback
virtual ~EventsCallback ()
 
virtual Graphics::ScreengetScreen () const
 

Public Attributes

const Std::string c_empty_string
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

bool initialize () override
 
bool isDataRequired (Common::Path &folder, int &majorVersion, int &minorVersion) override
 
- Protected Member Functions inherited from Ultima::Shared::UltimaEngine
virtual void deinitialize ()
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 
virtual void pauseEngineIntern (bool pause)
 

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 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

◆ initialize()

bool Ultima::Nuvie::NuvieEngine::initialize ( )
overrideprotectedvirtual

Initializes needed data for the engine

Reimplemented from Ultima::Shared::UltimaEngine.

◆ isDataRequired()

bool Ultima::Nuvie::NuvieEngine::isDataRequired ( Common::Path folder,
int &  majorVersion,
int &  minorVersion 
)
overrideprotectedvirtual

Returns the data archive folder and version that's required

Reimplemented from Ultima::Shared::UltimaEngine.

◆ run()

Common::Error Ultima::Nuvie::NuvieEngine::run ( )
overridevirtual

Play the game

Implements Engine.

◆ syncSoundSettings()

void Ultima::Nuvie::NuvieEngine::syncSoundSettings ( )
overridevirtual

Synchronize sound settings

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Ultima::Nuvie::NuvieEngine::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::Nuvie::NuvieEngine::canSaveGameStateCurrently ( bool  isAutosave)
overridevirtual

Indicates whether a game state can be saved.

Parameters
isAutosaveFlags whether it's an autosave check

Implements Ultima::Shared::UltimaEngine.

◆ loadGameState()

Common::Error Ultima::Nuvie::NuvieEngine::loadGameState ( int  slot)
overridevirtual

Load a game state.

Parameters
slotthe slot from which a savestate should be loaded
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

◆ saveGameState()

Common::Error Ultima::Nuvie::NuvieEngine::saveGameState ( int  slot,
const Common::String desc,
bool  isAutosave 
)
overridevirtual

Save a game state.

Parameters
slotthe slot into which the savestate should be stored
desca description for the savestate, entered by the user
isAutosaveIf true, autosave is being created
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

◆ journeyOnwards()

bool Ultima::Nuvie::NuvieEngine::journeyOnwards ( )

Either starts the most recently saved game, or falls back on starting a new game

◆ loadLatestSave()

bool Ultima::Nuvie::NuvieEngine::loadLatestSave ( )

Loads the most recently saved game

◆ quickSave()

bool Ultima::Nuvie::NuvieEngine::quickSave ( int  saveSlot,
bool  isLoad 
)

Quick save or load a savegame

◆ getSoundManager()

SoundManager* Ultima::Nuvie::NuvieEngine::getSoundManager ( ) const
inline

Return a reference to the sound manager


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