Inheritance diagram for AGDS::AGDSEngine:

Classes
struct	Color

Public Member Functions
	AGDSEngine (OSystem syst, const ADGameDescription gameDesc)

	AGDSEngine (const AGDSEngine &)=delete

Common::Error	run () override

void	setGlobal (const Common::String &name, int value)

int	getGlobal (const Common::String &name) const

bool	hasGlobal (const Common::String &name) const

bool	hasFeature (EngineFeature f) const override

Common::Error	loadGameState (int slot) override

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

bool	canLoadGameStateCurrently (Common::U32String *msg) override

bool	canSaveGameStateCurrently (Common::U32String *msg) override

ObjectPtr	loadObject (const Common::String &name, const Common::String &prototype=Common::String(), bool allowInitialise=true)

ObjectPtr	runObject (const Common::String &name, const Common::String &prototype=Common::String(), bool allowInitialise=true)

void	runObject (const ObjectPtr &object)

void	runProcess (const ObjectPtr &object, uint ip=0)

ProcessPtr	findProcess (const Common::String &name) const

void	reactivate (const Common::String &name, const Common::String &where, bool runNow=false)

bool	hasActiveProcesses (const Common::String &name) const

void	runPendingReactivatedProcesses ()

void	resetCurrentScreen ()

void	loadScreen (const Common::String &name, ScreenLoadingType type, bool savePatch=true)

void	loadNextScreen ()

void	saveScreenPatch ()

RegionPtr	loadRegion (const Common::String &name)

Common::String	loadText (const Common::String &name)

int	appendToSharedStorage (const Common::String &value)

const Common::String &	getSharedStorage (int id) const

bool	active () const

void	playFilm (Process &process, const Common::String &video, const Common::String &audio, const Common::String &subtitles)

void	skipFilm ()

ResourceManager &	resourceManager ()

SoundManager &	soundManager ()

Inventory &	inventory ()

Dialog &	dialog ()

const ProcessListType &	processes () const

TextLayout &	textLayout ()

Screen *	getCurrentScreen ()

Console *	getConsole ()

Common::String &	getCurrentScreenName ()

ObjectPtr	getCurrentScreenObject (const Common::String &name)

const Graphics::PixelFormat &	pixelFormat () const

Graphics::ManagedSurface *	loadPicture (const Common::String &name)

Graphics::Surface *	createSurface (int w, int h)

Graphics::ManagedSurface *	convertToTransparent (Graphics::Surface *surface)

int	loadFromCache (const Common::String &name) const

Graphics::ManagedSurface *	loadFromCache (int id) const

int	saveToCache (const Common::String &name, Graphics::ManagedSurface *surface)

void	loadFont (int id, const Common::String &name, int gw, int gh)

const Graphics::Font *	getFont (int id) const

AnimationPtr	loadAnimation (const Common::String &name)

AnimationPtr	loadMouseCursor (const Common::String &name)

AnimationPtr	findAnimationByPhaseVar (const Common::String &phaseVar)

void	loadCharacter (const Common::String &id, const Common::String &name, const Common::String &object)

Character *	getCharacter (const Common::String &name)

Character *	currentCharacter () const

Character *	jokes () const

void	loadDefaultMouseCursor (const Common::String &name)

void	changeMouseArea (int id, int enabled)

void	enableUser (bool enabled)

void	enableSystemUser (bool enabled)

bool	userEnabled () const

void	newGame ()

void	initSystemVariables ()

SystemVariable *	getSystemVariable (const Common::String &name)

void	setNextScreenName (const Common::String &nextScreenName, ScreenLoadingType type)

void	returnToPreviousScreen ()

void	tickInventory ()

void	playSoundSync (int syncSoundId)

void	setAmbientSoundId (int id)

void	tell (Process &process, const Common::String &region, Common::String text, Common::String sound, bool npc)

bool	fastMode () const

Common::Point	mousePosition () const

void	currentInventoryObject (const ObjectPtr &object)

void	resetCurrentInventoryObject ()

ObjectPtr	popCurrentInventoryObject ()

const ObjectPtr &	currentInventoryObject () const

bool	showHints () const

PatchPtr	getPatch (const Common::String &screenName) const

PatchPtr	createPatch (const Common::String &screenName)

ObjectPatchPtr	getObjectPatch (const Common::String &screenName) const

ObjectPatchPtr	createObjectPatch (const Common::String &screenName)

void	shadowIntensity (int intensity)

int	getRandomNumber (int max)

void	curtain (const Common::String &process, int screen, int sound, int music, bool updateGlobals)

bool	activeCurtain () const

bool	v2 () 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	loadGameStream (Common::SeekableReadStream *stream)

void	setGameToLoadSlot (int slot)

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

bool	saveGameDialog ()

bool	loadGameDialog ()

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)

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

Protected Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)

void	defaultSyncSoundSettings ()

virtual void	pauseEngineIntern (bool pause)

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 AGDS::AGDSEngine::run ( )

overridevirtual

Initialize the engine and start its main loop.

Returns: kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool AGDS::AGDSEngine::hasFeature ( EngineFeature f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ loadGameState()

Common::Error AGDS::AGDSEngine::loadGameState ( int slot )

overridevirtual

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.

◆ saveGameState()

Common::Error AGDS::AGDSEngine::saveGameState	(	int	slot,
		const Common::String &	desc,
		bool	isAutosave = `false`
	)

overridevirtual

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.

◆ canLoadGameStateCurrently()

bool AGDS::AGDSEngine::canLoadGameStateCurrently ( Common::U32String * msg )

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 AGDS::AGDSEngine::canSaveGameStateCurrently ( Common::U32String * msg )

inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

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

engines/agds/agds.h

Classes

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ run()

◆ hasFeature()

◆ loadGameState()

◆ saveGameState()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()