Composer::ComposerEngine Class Reference

Inheritance diagram for Composer::ComposerEngine:

Public Member Functions
	ComposerEngine (OSystem *syst, const ComposerGameDescription *gameDesc)
bool	hasFeature (EngineFeature f) const override
int	getGameType () const
const char *	getGameId () const
uint32	getFeatures () const
Common::Language	getLanguage () const
Common::Platform	getPlatform () const
bool	loadDetectedConfigFile (Common::INIFile &configFile) 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
	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::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
const ComposerGameDescription *	_gameDescription
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override
template<typename T >
void	syncArray (Common::Serializer &ser, Common::Array< T > &data, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
template<typename T >
void	syncList (Common::Serializer &ser, Common::List< T > &data, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
template<typename T >
void	syncListReverse (Common::Serializer &ser, Common::List< T > &data, Common::Serializer::Version minVersion=0, Common::Serializer::Version maxVersion=Common::Serializer::kLastVersion)
template<typename T >
void	sync (Common::Serializer &ser, T &data, Common::Serializer::Version minVersion, Common::Serializer::Version maxVersion)
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	loadGameState (int slot) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
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 bool	warnUserAboutUnsupportedGame (Common::String msg=Common::String())
static void	errorUnsupportedGame (Common::String extraMsg)
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

run()

Common::Error Composer::ComposerEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

canLoadGameStateCurrently()

bool Composer::ComposerEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

inlineoverrideprotectedvirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

loadGameState()

Common::Error Composer::ComposerEngine::loadGameState ( int  slot )

overrideprotectedvirtual

Load a game state.

Parameters

slot	The slot from which a save state should be loaded.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

canSaveGameStateCurrently()

bool Composer::ComposerEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

inlineoverrideprotectedvirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

saveGameState()

Common::Error Composer::ComposerEngine::saveGameState ( int  slot, const Common::String &  desc, bool  isAutosave = false  )

overrideprotectedvirtual

Save a game state.

Parameters

slot	The slot into which the save state should be stored.
desc	Description for the save state, entered by the user.
isAutosave	Expected to be true if an autosave is being created.

Returns

kNoError on success, otherwise an error code.

Reimplemented from Engine.

hasFeature()

bool Composer::ComposerEngine::hasFeature ( EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

---

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

• engines/composer/composer.h