Groovie::GroovieEngine Class Reference

Inheritance diagram for Groovie::GroovieEngine:

Public Member Functions
	GroovieEngine (OSystem *syst, const GroovieGameDescription *gd)
Common::Platform	getPlatform () const
EngineVersion	getEngineVersion () const
int	getAutosaveSlot () const override
bool	canLaunchLoad () const
bool	isDemo () const
void	waitForInput ()
bool	isWaitingForInput ()
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 ()
	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	loadGameStream (Common::SeekableReadStream *stream)
void	setGameToLoadSlot (int slot)
virtual Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
bool	saveGameDialog ()
bool	loadGameDialog ()

Public Attributes
Graphics::PixelFormat	_pixelFormat
bool	_spookyMode
Script *	_script
ResMan *	_resMan
GrvCursorMan *	_grvCursorMan
VideoPlayer *	_videoPlayer
SoundEffectQueue	_soundQueue
MusicPlayer *	_musicPlayer
GraphicsMan *	_graphicsMan
const Graphics::Font *	_font
Common::MacResManager *	_macResFork
GameSpeed	_modeSpeed
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Static Public Attributes
static const int	AUTOSAVE_SLOT

Protected Member Functions
Common::Error	run () override
void	pauseEngineIntern (bool pause) override
bool	hasFeature (EngineFeature f) const override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	loadGameState (int slot) override
Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
void	syncSoundSettings () override
Protected Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)
void	defaultSyncSoundSettings ()

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

getAutosaveSlot()

int Groovie::GroovieEngine::getAutosaveSlot ( ) const

overridevirtual

Return the slot that should be used for autosaves, or -1 for engines that don't support autosave.

Note

This should match the meta engine getAutosaveSlot() method.

Reimplemented from Engine.

run()

Common::Error Groovie::GroovieEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

pauseEngineIntern()

void Groovie::GroovieEngine::pauseEngineIntern ( bool  pause )

overrideprotectedvirtual

Actual implementation of pauseEngine by subclasses.

See also

Engine::pauseEngine

Reimplemented from Engine.

hasFeature()

bool Groovie::GroovieEngine::hasFeature ( EngineFeature  f ) const

overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool Groovie::GroovieEngine::canLoadGameStateCurrently ( Common::U32String *  msg = nullptr )

overrideprotectedvirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

canSaveGameStateCurrently()

bool Groovie::GroovieEngine::canSaveGameStateCurrently ( Common::U32String *  msg = nullptr )

overrideprotectedvirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

loadGameState()

Common::Error Groovie::GroovieEngine::loadGameState ( int  slot )

overrideprotectedvirtual

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 Groovie::GroovieEngine::saveGameState ( int  slot, const Common::String &  desc, bool  isAutosave = false  )

overrideprotectedvirtual

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.

syncSoundSettings()

void Groovie::GroovieEngine::syncSoundSettings ( )

overrideprotectedvirtual

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/groovie/groovie.h