Inheritance diagram for Saga::SagaEngine:

Public Member Functions
Common::Error	run () override

bool	hasFeature (EngineFeature f) const override

void	syncSoundSettings () override

void	pauseEngineIntern (bool pause) override

	SagaEngine (OSystem syst, const SAGAGameDescription gameDesc)

void	save (const char fileName, const char saveName)

void	load (const char *fileName)

uint32	getCurrentLoadVersion () const

void	fillSaveList ()

char *	calcSaveFileName (uint slotNumber)

Common::String	getSaveStateName (int slot) const override

SaveFileData *	getSaveFile (uint idx)

uint	getNewSaveSlotNumber () const

bool	locateSaveFile (char *saveName, uint &titleNumber)

bool	isSaveListFull () const

uint	getSaveFilesCount () const

bool	isIHNMDemo () const

bool	isITEAmiga () const

bool	isAGA () const

bool	isECS () const

unsigned	getPalNumEntries () const

GameIntroList	getIntroList () const

bool	decodeBGImage (const ByteArray &imageData, ByteArray &outputBuffer, int w, int h, bool flip=false)

bool	decodeBGImageMask (const ByteArray &imageData, ByteArray &outputBuffer, int w, int h, bool flip=false)

const byte *	getImagePal (const ByteArray &imageData)

void	loadStrings (StringsTable &stringsTable, const ByteArray &stringsData, bool isBigEndian)

const char *	getObjectName (uint16 objectId) const

int	processInput ()

Point	mousePos () const

int	getMouseClickCount () const

void	incrementMouseClickCount ()

void	resetMouseClickCount ()

bool	leftMouseButtonPressed () const

bool	rightMouseButtonPressed () const

bool	mouseButtonPressed () const

int	ticksToMSec (int tick) const

bool	initGame ()

bool	isBigEndian () const

bool	isMacResources () const

const GameResourceDescription *	getResourceDescription () const

GameResourceList	getResourceList () const

GameFontList	getFontList () const

GamePatchList	getPatchList () const

int	getGameId () const

uint32	getFeatures () const

Common::Language	getLanguage () const

Common::Platform	getPlatform () const

int	getGameNumber () const

int	getStartSceneNumber () const

const ADGameFileDescription *	getFilesDescriptions () const

const ADGameFileDescription *	getArchivesDescriptions () const

const Common::Rect &	getDisplayClip () const

Common::Error	loadGameState (int slot) override

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

bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override

bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override

const GameDisplayInfo &	getDisplayInfo ()

int	getLanguageIndex ()

const char *	getTextString (int textStringId)

void	getExcuseInfo (int verb, const char *&textString, int &soundResourceId)

void	enableKeyMap (int mode)

ColorId	KnownColor2ColorId (KnownColor knownColor)

void	setTalkspeed (int talkspeed)

int	getTalkspeed () const

ColorId	iteColorBlack () const

ColorId	iteColorTransBlack () const

ColorId	iteColorBrightWhite () const

ColorId	iteColorWhite () const

ColorId	iteColorBottomDarkGrey () const

ColorId	iteColorBottomBlue () const

ColorId	iteColorBottomGrey () const

ColorId	iteColorBottomWhite () const

ColorId	iteColorBottomBrightWhite () const

ColorId	iteColorBottomGreen () const

ColorId	iteColorOptionsDarkGrey () const

ColorId	iteColorOptionsLightBlue92 () const

ColorId	iteColorOptionsLightBlue94 () const

ColorId	iteColorOptionsLightBlue96 () const

ColorId	iteColorOptionsDarkBlue8a () const

ColorId	iteColorOptionsDarkGrey0C () const

ColorId	iteColorOptionsBlue () const

ColorId	iteColorOptionsBrightWhite () 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	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
int16	_framesEsc

uint32	_globalFlags

int16	_ethicsPoints [8]

int	_spiritualBarometer

int	_soundVolume

int	_speechVolume

bool	_subtitlesEnabled

bool	_voicesEnabled

bool	_voiceFilesExist

int	_readingSpeed

bool	_copyProtection

bool	_musicWasPlaying

bool	_isIHNMDemo

bool	_hasITESceneSubstitutes

SndRes *	_sndRes

Sound *	_sound

Music *	_music

Anim *	_anim

Render *	_render

IsoMap *	_isoMap

Gfx *	_gfx

Script *	_script

Actor *	_actor

Font *	_font

Sprite *	_sprite

Scene *	_scene

Interface *	_interface

Console *	_console

Events *	_events

PalAnim *	_palanim

Puzzle *	_puzzle

Resource *	_resource

Common::RandomSource	_rnd

int32	_frameCount

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

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 Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)

void	defaultSyncSoundSettings ()

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 Saga::SagaEngine::run ( )

overridevirtual

Initialize the engine and start its main loop.

Returns: kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Saga::SagaEngine::hasFeature ( EngineFeature f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ syncSoundSettings()

void Saga::SagaEngine::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.

◆ pauseEngineIntern()

void Saga::SagaEngine::pauseEngineIntern ( bool pause )

overridevirtual

Actual implementation of pauseEngine by subclasses.

See also: Engine::pauseEngine

Reimplemented from Engine.

◆ getSaveStateName()

Common::String Saga::SagaEngine::getSaveStateName ( int slot ) const

inlineoverridevirtual

Generate the savegame filename.

Reimplemented from Engine.

◆ loadGameState()

Common::Error Saga::SagaEngine::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 Saga::SagaEngine::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 Saga::SagaEngine::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 Saga::SagaEngine::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/saga/saga.h

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ run()

◆ hasFeature()

◆ syncSoundSettings()

◆ pauseEngineIntern()

◆ getSaveStateName()

◆ loadGameState()

◆ saveGameState()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()