Ultima::Shared::UltimaEarlyEngine Class Reference

Inheritance diagram for Ultima::Shared::UltimaEarlyEngine:

Public Member Functions
	UltimaEarlyEngine (OSystem *syst, const UltimaGameDescription *gameDesc)
Common::Error	run () override
bool	hasFeature (EngineFeature f) const override
void	playGame ()
uint	getRandomNumber (uint maxVal)
uint	getRandomNumber (uint min, uint max)
Graphics::Screen *	getScreen () const override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	loadGameStream (Common::SeekableReadStream *stream) override
Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
GameId	getGameId () const
bool	isEnhanced () const
Game *	createGame () const
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
virtual bool	gameTypeHasAddOns () const
virtual bool	dirCanBeGameAddOn (const Common::FSDirectory &dir) const
virtual bool	dirMustBeGameAddOn (const Common::FSDirectory &dir) const
Common::ErrorCode	updateAddOns (const MetaEngine *metaEngine) 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 ()
bool	enhancementEnabled (int32 cls)
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

Protected Attributes
const UltimaGameDescription *	_gameDescription
Protected Attributes inherited from Engine
Common::TimerManager *	_timer
Common::EventManager *	_eventMan
Common::SaveFileManager *	_saveFileMan
GUI::Dialog *	_mainMenuDialog
const Common::String	_targetName
int32	_activeEnhancements = kEnhGameBreakingBugFixes

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 bool	warnUserAboutUnsupportedAddOn (Common::String addOnName)
static void	errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)
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)

Member Function Documentation

run()

Common::Error Ultima::Shared::UltimaEarlyEngine::run ( )

overridevirtual

Main method for running the game

Implements Engine.

hasFeature()

bool Ultima::Shared::UltimaEarlyEngine::hasFeature ( EngineFeature  f ) const

overridevirtual

Returns supported engine features

Reimplemented from Engine.

playGame()

void Ultima::Shared::UltimaEarlyEngine::playGame

(

)

Play the game

getRandomNumber() [1/2]

uint Ultima::Shared::UltimaEarlyEngine::getRandomNumber ( uint  maxVal )

inline

Get a random number

getRandomNumber() [2/2]

uint Ultima::Shared::UltimaEarlyEngine::getRandomNumber ( uint  min, uint  max  )

inline

Gets a random number

getScreen()

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

overridevirtual

Get the screen

Reimplemented from Ultima::Shared::EventsCallback.

canLoadGameStateCurrently()

bool Ultima::Shared::UltimaEarlyEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

overridevirtual

Indicates whether a game state can be loaded.

Parameters

isAutosave

Flags whether it's an autosave check

Reimplemented from Engine.

canSaveGameStateCurrently()

bool Ultima::Shared::UltimaEarlyEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

overridevirtual

Indicates whether a game state can be saved.

Parameters

isAutosave

Flags whether it's an autosave check

Reimplemented from Engine.

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.

getGameId()

GameId Ultima::Shared::UltimaEarlyEngine::getGameId

(

)

const

Returns the game type being played

isEnhanced()

bool Ultima::Shared::UltimaEarlyEngine::isEnhanced

(

)

const

Returns true if the game is running an enhanced version as compared to the original game

---

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

• engines/ultima/shared/early/ultima_early.h