Agi::AgiBase Class Reference

Inheritance diagram for Agi::AgiBase:

Public Member Functions
virtual bool	promptIsEnabled ()
virtual int	getKeypress ()=0
virtual bool	isKeypress ()=0
virtual void	clearKeyQueue ()=0
	AgiBase (OSystem *syst, const AGIGameDescription *gameDesc)
virtual void	clearImageStack ()=0
virtual void	recordImageStackCall (uint8 type, int16 p1, int16 p2, int16 p3, int16 p4, int16 p5, int16 p6, int16 p7)=0
virtual void	replayImageStackCall (uint8 type, int16 p1, int16 p2, int16 p3, int16 p4, int16 p5, int16 p6, int16 p7)=0
virtual void	releaseImageStack ()=0
bool	getFlag (int16 flagNr)
void	setFlag (int16 flagNr, bool newState)
void	flipFlag (int16 flagNr)
void	setFlagOrVar (int16 flagNr, bool newState)
uint32	getGameID () const
uint32	getFeatures () const
uint16	getVersion () const
uint16	getGameType () const
Common::Language	getLanguage () const
bool	isLanguageRTL () const
Common::Platform	getPlatform () const
const char *	getGameMD5 () const
void	initFeatures ()
void	initVersion ()
const char *	getDiskName (uint16 id)
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
const byte *	getFontData ()
void	cycleInnerLoopActive (int16 loopType)
void	cycleInnerLoopInactive ()
bool	cycleInnerLoopIsActive ()
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)
virtual Common::Error	loadGameStream (Common::SeekableReadStream *stream)
void	setGameToLoadSlot (int slot)
virtual Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
virtual Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
bool	saveGameDialog ()
bool	loadGameDialog ()

Public Attributes
Words *	_words
GfxFont *	_font
GfxMgr *	_gfx
Common::RenderMode	_renderMode
AgiDebug	_debug
AgiGame	_game
Common::RandomSource *	_rnd
SoundMgr *	_sound
Mouse	_mouse
bool	_noSaveLoadAllowed
int	_soundemu
const AGIGameDescription *	_gameDescription
uint32	_gameFeatures
uint16	_gameVersion
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	init ()
virtual Common::Error	go ()=0
Common::Error	run () override
bool	hasFeature (EngineFeature f) const override
virtual void	initialize ()=0
void	initRenderMode ()
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 bool	warnUserAboutUnsupportedAddOn (Common::String addOnName)
static void	errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)
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 Agi::AgiBase::run ( )

inlineoverrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

hasFeature()

bool Agi::AgiBase::hasFeature ( EngineFeature  f ) const

overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

setFlagOrVar()

void Agi::AgiBase::setFlagOrVar	(	int16	flagNr,
		bool	newState
	)

Sets a flag in AGIv2+, sets a variable in AGIv1

canLoadGameStateCurrently()

bool Agi::AgiBase::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 Agi::AgiBase::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.

---

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

• engines/agi/agi.h