ZVision::ZVision Class Reference

Inheritance diagram for ZVision::ZVision:

Public Member Functions
	ZVision (OSystem *syst, const ZVisionGameDescription *gameDesc)
Common::Error	run () override
void	pauseEngineIntern (bool pause) override
ZVisionGameId	getGameId () const
Common::Language	getLanguage () const
uint32	getFeatures () const
ScriptManager *	getScriptManager () const
RenderManager *	getRenderManager () const
CursorManager *	getCursorManager () const
SaveManager *	getSaveManager () const
StringManager *	getStringManager () const
SearchManager *	getSearchManager () const
TextRenderer *	getTextRenderer () const
MidiManager *	getMidiManager () const
MenuHandler *	getMenuHandler () const
Common::Keymap *	getGameKeymap () const
Common::RandomSource *	getRandomSource () const
int16	getKeyboardVelocity () const
int16	getMouseVelocity () const
uint8	getZvisionKey (Common::KeyCode scummKeyCode)
void	startClock ()
void	stopClock ()
void	initScreen ()
void	initHiresScreen ()
void	playVideo (Video::VideoDecoder &videoDecoder, const Common::Rect &destRect=Common::Rect(0, 0, 0, 0), bool skippable=true, Subtitle *sub=NULL)
Video::VideoDecoder *	loadAnimation (const Common::Path &fileName)
void	setRenderDelay (uint)
bool	canRender ()
void	fpsTimer ()
int	getFPS () const
void	syncSoundSettings () override
void	loadSettings ()
void	saveSettings ()
bool	ifQuit ()
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
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::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 ()

Static Public Member Functions
static void	fpsTimerCallback (void *refCon)
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)

Public Attributes
Common::Rect	_workingWindow
const Graphics::PixelFormat	_resourcePixelFormat
const Graphics::PixelFormat	_screenPixelFormat
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 }
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

Member Function Documentation

run()

Common::Error ZVision::ZVision::run ( )

overridevirtual

Initialize the engine and start its main loop.

Returns

kNoError on success, otherwise an error code.

Implements Engine.

pauseEngineIntern()

void ZVision::ZVision::pauseEngineIntern ( bool  pause )

overridevirtual

Actual implementation of pauseEngine by subclasses.

See also

Engine::pauseEngine

Reimplemented from Engine.

playVideo()

void ZVision::ZVision::playVideo	(	Video::VideoDecoder &	videoDecoder,
		const Common::Rect &	destRect = Common::Rect(0, 0, 0, 0),
		bool	skippable = true,
		Subtitle *	sub = NULL
	)

Play a video until it is finished. This is a blocking call. It will call _clock.stop() when the video starts and _clock.start() when the video finishes. It will also consume all events during video playback.

Parameters

videoDecoder	The video to play
destRect	Where to put the video. (In working window coords)
skippable	If true, the video can be skipped at any time using [Spacebar]

syncSoundSettings()

void ZVision::ZVision::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.

hasFeature()

bool ZVision::ZVision::hasFeature ( EngineFeature  f ) const

overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

canLoadGameStateCurrently()

bool ZVision::ZVision::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 ZVision::ZVision::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.

loadGameState()

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

Member Data Documentation

_workingWindow

Common::Rect ZVision::ZVision::_workingWindow

A Rectangle centered inside the actual window. All in-game coordinates are given in this coordinate space. Also, all images are clipped to the edges of this Rectangle

---

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

• engines/zvision/zvision.h