Inheritance diagram for Got::GotEngine:

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

uint32	getFeatures () const

bool	isDemo () const override

Common::String	getGameId () const

uint32	getRandomNumber (uint maxNum)

bool	hasFeature (EngineFeature f) const override

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

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

Common::Error	syncGame (Common::Serializer &s)

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

Common::Error	loadGameStream (Common::SeekableReadStream *stream) override

void	syncSoundSettings () override

void	pauseEngineIntern (bool pause) override

Common::String	getHighScoresSaveName () 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::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 Member Functions inherited from Got::Events
void	runGame ()

void	replaceView (UIElement *ui, bool replaceAllViews=false, bool fadeOutIn=false) override

void	replaceView (const Common::String &name, bool replaceAllViews=false, bool fadeOutIn=false) override

void	addView (UIElement *ui) override

void	addView (const Common::String &name) override

void	clearViews ()

void	popView ()

UIElement *	focusedView () const

UIElement *	priorView () const

UIElement *	firstView () const

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

bool	isInCombat () const

Graphics::Screen *	getScreen () const

void	drawElements () override

void	draw () override

bool	tick () override

void	close () override

Public Member Functions inherited from Got::UIElement
	UIElement (const Common::String &name, UIElement *uiParent)

	UIElement (const Common::String &name)

bool	needsRedraw () const

void	redraw ()

void	addView ()

void	open ()

int	getRandomNumber (int minNumber, int maxNumber)

int	getRandomNumber (int maxNumber)

virtual void	setBounds (const Common::Rect &r)

Common::Rect	getBounds () const

const Common::String &	getName () const

Gfx::GfxSurface	getSurface (bool innerBounds=false) const

virtual UIElement *	findView (const Common::String &name)

bool	send (const MouseMoveMessage &msg)

bool	send (const Common::String &viewName, const FocusMessage &msg)

bool	send (const FocusMessage &msg)

bool	send (const Common::String &viewName, const UnfocusMessage &msg)

bool	send (const UnfocusMessage &msg)

bool	send (const Common::String &viewName, const MouseEnterMessage &msg)

bool	send (const MouseEnterMessage &msg)

bool	send (const Common::String &viewName, const MouseLeaveMessage &msg)

bool	send (const MouseLeaveMessage &msg)

bool	send (const Common::String &viewName, const KeypressMessage &msg)

bool	send (const KeypressMessage &msg)

bool	send (const Common::String &viewName, const MouseDownMessage &msg)

bool	send (const MouseDownMessage &msg)

bool	send (const Common::String &viewName, const MouseUpMessage &msg)

bool	send (const MouseUpMessage &msg)

bool	send (const Common::String &viewName, const ActionMessage &msg)

bool	send (const ActionMessage &msg)

bool	send (const Common::String &viewName, const GameMessage &msg)

bool	send (const GameMessage &msg)

bool	send (const Common::String &viewName, const ValueMessage &msg)

bool	send (const ValueMessage &msg)

Public Attributes
Vars	_vars

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override

bool	shouldQuit () const override

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

void	defaultSyncSoundSettings ()

Protected Member Functions inherited from Got::Events
bool	msgAction (const ActionMessage &e) override

bool	msgFocus (const FocusMessage &e) override

bool	msgUnfocus (const UnfocusMessage &e) override

bool	msgMouseEnter (const MouseEnterMessage &e) override

bool	msgMouseLeave (const MouseLeaveMessage &e) override

bool	msgKeypress (const KeypressMessage &e) override

bool	msgMouseDown (const MouseDownMessage &e) override

bool	msgMouseUp (const MouseUpMessage &e) override

bool	msgMouseMove (const MouseMoveMessage &e) override

Protected Member Functions inherited from Got::UIElement
bool	isDelayActive () const

void	cancelDelay ()

virtual void	timeout ()

void	stopTextToSpeech ()

virtual bool	msgGame (const GameMessage &e)

virtual bool	msgValue (const ValueMessage &e)

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

Protected Attributes inherited from Got::UIElement
UIElement *	_parent

Common::Array< UIElement * >	_children

Common::Rect	_innerBounds

Bounds	_bounds

bool	_needsRedraw = true

Common::String	_name

Common::String	_previousSaid

Member Function Documentation

◆ run()

Common::Error Got::GotEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns: kNoError on success, otherwise an error code.

Implements Engine.

◆ shouldQuit()

bool Got::GotEngine::shouldQuit ( ) const

inlineoverrideprotectedvirtual

Returns true if the game should quit

Implements Got::Events.

◆ getGameId()

Common::String Got::GotEngine::getGameId ( ) const

Returns the game Id

◆ getRandomNumber()

uint32 Got::GotEngine::getRandomNumber ( uint maxNum )

inline

Gets a random number

◆ hasFeature()

bool Got::GotEngine::hasFeature ( EngineFeature f ) const

inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Got::GotEngine::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 Got::GotEngine::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.

◆ syncGame()

Common::Error Got::GotEngine::syncGame ( Common::Serializer & s )

Uses a serializer to allow implementing savegame loading and saving using a single method

◆ saveGameStream()

Common::Error Got::GotEngine::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 Got::GotEngine::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 Got::GotEngine::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 Got::GotEngine::pauseEngineIntern ( bool pause )

overridevirtual

Actual implementation of pauseEngine by subclasses.

See also: Engine::pauseEngine

Reimplemented from Engine.

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

engines/got/got.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ run()

◆ shouldQuit()

◆ getGameId()

◆ getRandomNumber()

◆ hasFeature()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()

◆ syncGame()

◆ saveGameStream()

◆ loadGameStream()

◆ syncSoundSettings()

◆ pauseEngineIntern()