QDEngine::QDEngineEngine Class Reference

Inheritance diagram for QDEngine::QDEngineEngine:

Public Member Functions
	QDEngineEngine (OSystem *syst, const ADGameDescription *gameDesc)
uint32	getFeatures () const
Common::Language	getLanguage () const
Common::String	getGameId () const
Common::String	getTargetName () const
const char *	getExeName () const
uint32	getRandomNumber (uint maxNum)
void	setSeed (uint32 seed)
bool	hasFeature (EngineFeature f) const override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
Common::Error	loadGameStream (Common::SeekableReadStream *stream) override
void	syncSoundSettings () override
int	engineMain ()
const Vect2i &	screen_offset ()
void	set_screen_offset (const Vect2i &offset)
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	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 Attributes
Graphics::Screen *	_screen = nullptr
Graphics::PixelFormat	_pixelformat
int	_tagMap [QDSCR_MAX_KEYWORD_ID]
int	_screenW
int	_screenH
bool	_forceFullRedraw = false
int	_thumbSizeX = 0
int	_thumbSizeY = 0
bool	_debugDraw = false
bool	_debugDrawGrid = false
int	_gameVersion = 0
Vect2i	_screen_offset = Vect2i(0, 0)
grScreenRegion	_fps_region = grScreenRegion_EMPTY
grScreenRegion	_fps_region_last = grScreenRegion_EMPTY
Std::vector< qdGameObject * >	_visible_objects
qdScreenTextFormat	_default_format
qdScreenTextFormat	_global_text_format
qdScreenTextFormat	_global_topic_format
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () 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 QDEngine::QDEngineEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

getGameId()

Common::String QDEngine::QDEngineEngine::getGameId

(

)

const

Returns the game Id

getRandomNumber()

uint32 QDEngine::QDEngineEngine::getRandomNumber ( uint  maxNum )

inline

Gets a random number

hasFeature()

bool QDEngine::QDEngineEngine::hasFeature ( EngineFeature  f ) const

inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool QDEngine::QDEngineEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

canSaveGameStateCurrently()

bool QDEngine::QDEngineEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

saveGameStream()

Common::Error QDEngine::QDEngineEngine::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.

loadGameStream()

Common::Error QDEngine::QDEngineEngine::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.

syncSoundSettings()

void QDEngine::QDEngineEngine::syncSoundSettings ( )

overridevirtual

Notify the engine that the sound settings in the config manager might have changed and that it should adjust any internal volume (and other) values accordingly.

The default implementation sets the volume levels of all mixer sound types according to the config entries of the active domain. When overwriting, call the default implementation first, then adjust the volumes further (if required).

Note

When setting volume levels, respect the "mute" config entry.

The volume for the plain sound type is reset to the maximum volume. If the engine can associate its own value for this type, it needs to overwrite this member and set it accordingly.

Reimplemented from Engine.

---

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

• engines/qdengine/qdengine.h