Cruise::CruiseEngine Class Reference

Inheritance diagram for Cruise::CruiseEngine:

Classes
struct	MemInfo

Public Types
typedef Common::List< Common::Rect >	RectList
Public Types inherited from Engine
enum	EngineFeature {   kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,   kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride }

Public Member Functions
	CruiseEngine (OSystem *syst, const CRUISEGameDescription *gameDesc)
bool	hasFeature (EngineFeature f) const override
int	getGameType () const
const char *	getGameId () const
uint32	getFeatures () const
Common::Language	getLanguage () const
Common::Platform	getPlatform () const
PCSound &	sound ()
virtual void	pauseEngine (bool pause)
const char *	langString (LangStringId langId)
Common::Error	loadGameState (int slot) override
bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
Common::String	getSaveStateName (int slot) const override
void	syncSoundSettings () override
void	initAllData ()
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
	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 ()

Static Public Member Functions
static const char *	getSavegameFile (int saveGameIdx)
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)

Public Attributes
const CRUISEGameDescription *	_gameDescription
Common::RandomSource	_rnd
Common::List< MemInfo * >	_memList
RectList	_dirtyRects
RectList	_priorFrameRects
Common::File	_currentVolumeFile
Common::Array< CtStruct >	_polyStructNorm
Common::Array< CtStruct >	_polyStructExp
Common::Array< CtStruct > *	_polyStructs
Common::Array< CtStruct > *	_polyStruct
Common::File	_PAL_file
Public Attributes inherited from Engine
OSystem *	_system
Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override
void	shutdown ()
bool	initGame ()
Protected Member Functions inherited from Engine
virtual int	runDialog (GUI::Dialog &dialog)
void	defaultSyncSoundSettings ()
virtual void	pauseEngineIntern (bool pause)

Additional Inherited Members
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 Cruise::CruiseEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

hasFeature()

bool Cruise::CruiseEngine::hasFeature ( EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

loadGameState()

Common::Error Cruise::CruiseEngine::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.

canLoadGameStateCurrently()

bool Cruise::CruiseEngine::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.

saveGameState()

Common::Error Cruise::CruiseEngine::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.

canSaveGameStateCurrently()

bool Cruise::CruiseEngine::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.

getSaveStateName()

Common::String Cruise::CruiseEngine::getSaveStateName ( int  slot ) const

inlineoverridevirtual

Generate the savegame filename.

Reimplemented from Engine.

syncSoundSettings()

void Cruise::CruiseEngine::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.

---

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

• engines/cruise/cruise.h