Inheritance diagram for Cine::CineEngine:

Public Member Functions
	CineEngine (OSystem syst, const CINEGameDescription gameDesc)

void	syncSoundSettings () override

bool	mayHave256Colors () const

int	getGameType () const

uint32	getFeatures () const

Common::Language	getLanguage () const

Common::Platform	getPlatform () const

bool	loadSaveDirectory ()

void	makeSystemMenu ()

int	scummVMSaveLoadDialog (bool isSave)

int	modifyGameSpeed (int speedChange)

void	setDefaultGameSpeed ()

uint32	getTimerDelay () const

Common::Error	loadGameState (int slot) override

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

Common::String	getSaveStateName (int slot) const override

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

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

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 ()

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
const CINEGameDescription *	_gameDescription

Common::File	_partFileHandle

Common::RandomSource	_rnd

StringToVolumeResourceArrayHashMap	_volumeEntriesMap

TextHandler	_textHandler

bool	_restartRequested

Common::Array< AnimData >	_animDataTable

Common::List< BGIncrust >	_bgIncrustList

Common::StringArray	_messageTable

Common::Array< ObjectStruct >	_objectTable

Common::List< overlay >	_overlayList

Common::Array< PalEntry >	_palArray

Common::Array< PartBuffer >	_partBuffer

ScriptList	_globalScripts

ScriptList	_objectScripts

RawObjectScriptArray	_relTable
	Object script bytecode table.

ScriptVars	_globalVars

RawScriptArray	_scriptTable
	Table of script bytecode.

FWScriptInfo *	_scriptInfo

Common::Array< int16 >	_zoneData

Common::Array< uint16 >	_zoneQuery
	Only exists in Operation Stealth.

Common::List< SeqListElement >	_seqList

Common::String	_commandBuffer

Common::Array< Common::KeyState >	_keyInputList

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override

bool	hasFeature (EngineFeature f) const 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
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 MetaEngineDetection &	getMetaEngineDetection ()

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

Member Function Documentation

◆ run()

Common::Error Cine::CineEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns: kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Cine::CineEngine::hasFeature ( EngineFeature f ) const

overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ syncSoundSettings()

void Cine::CineEngine::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.

◆ loadGameState()

Common::Error Cine::CineEngine::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 Cine::CineEngine::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.

◆ getSaveStateName()

Common::String Cine::CineEngine::getSaveStateName ( int slot ) const

overridevirtual

Generate the savegame filename.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Cine::CineEngine::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 Cine::CineEngine::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.

Member Data Documentation

◆ _globalVars

ScriptVars Cine::CineEngine::_globalVars

Global variables. 255 of these are saved, but there's one more that's used for bypassing the copy protection. In CineEngine::mainLoop(int bootScriptIdx) there's this code: globalVars[VAR_BYPASS_PROTECTION] = 0; And as VAR_BYPASS_PROTECTION is 255 that's why we're allocating one more than we otherwise would.

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

engines/cine/cine.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ run()

◆ hasFeature()

◆ syncSoundSettings()

◆ loadGameState()

◆ saveGameState()

◆ getSaveStateName()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()

Member Data Documentation

◆ _globalVars