Nancy::NancyEngine Class Reference

Inheritance diagram for Nancy::NancyEngine:

Public Member Functions
	NancyEngine (OSystem *syst, const NancyGameDescription *gd)
void	errorString (const char *buf_input, char *buf_output, int buf_output_size) override
bool	hasFeature (EngineFeature f) const override
Common::Error	loadGameStream (Common::SeekableReadStream *stream) override
Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
void	secondChance ()
const char *	getCopyrightString () const
uint32	getGameFlags () const
const char *	getGameId () const
GameType	getGameType () const
Common::Language	getGameLanguage () const
Common::Platform	getPlatform () const
const StaticData &	getStaticData () const
const EngineData *	getEngineData (const Common::String &name) const
void	setState (NancyState::NancyState state, NancyState::NancyState overridePrevious=NancyState::kNone)
NancyState::NancyState	getState ()
void	setToPreviousState ()
void	setMouseEnabled (bool enabled)
void	addDeferredLoader (Common::SharedPtr< DeferredLoader > &loaderPtr)
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 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 ()

Static Public Member Functions
static NancyEngine *	create (GameType type, OSystem *syst, const NancyGameDescription *gd)
Static Public Member Functions inherited from Engine
static void	quitGame ()
static bool	shouldQuit ()
static bool	warnUserAboutUnsupportedGame (Common::String msg=Common::String())
static void	errorUnsupportedGame (Common::String extraMsg)

Public Attributes
const byte	_true
const byte	_false
ResourceManager *	_resource
GraphicsManager *	_graphics
CursorManager *	_cursor
InputManager *	_input
SoundManager *	_sound
Common::RandomSource *	_randomSource
bool	_hasJustSaved
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override
void	pauseEngineIntern (bool pause) 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 }
Protected Attributes inherited from Engine
Common::TimerManager *	_timer
Common::EventManager *	_eventMan
Common::SaveFileManager *	_saveFileMan
GUI::Dialog *	_mainMenuDialog
const Common::String	_targetName
int32	_activeEnhancements = kEnhGameBreakingBugFixes

Member Function Documentation

errorString()

void Nancy::NancyEngine::errorString ( const char *  buf_input, char *  buf_output, int  buf_output_size  )

overridevirtual

Prepare an error string that is printed by the error() function.

Reimplemented from Engine.

hasFeature()

bool Nancy::NancyEngine::hasFeature ( EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

loadGameStream()

Common::Error Nancy::NancyEngine::loadGameStream ( Common::SeekableReadStream *  stream )

overridevirtual

Load a game state.

Parameters

stream

The stream to load the save state from.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

saveGameStream()

Common::Error Nancy::NancyEngine::saveGameStream ( Common::WriteStream *  stream, bool  isAutosave = false  )

overridevirtual

Save a game state.

Parameters

stream	The write stream to save the savegame data to.
isAutosave	Expected to be true if an autosave is being created.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool Nancy::NancyEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

overridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

canSaveGameStateCurrently()

bool Nancy::NancyEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

overridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

run()

Common::Error Nancy::NancyEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

pauseEngineIntern()

void Nancy::NancyEngine::pauseEngineIntern ( bool  pause )

overrideprotectedvirtual

Actual implementation of pauseEngine by subclasses.

See also

Engine::pauseEngine

Reimplemented from Engine.

---

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

• engines/nancy/nancy.h