Inheritance diagram for PhoenixVR::PhoenixVREngine:

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

uint32	getFeatures () const

Common::String	getGameId () const

uint32	getRandomNumber (uint maxNum)

bool	hasFeature (EngineFeature f) const override

int	getAutosaveSlot () const override

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

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

void	syncSoundSettings () override

void	setNextScript (const Common::String &path)

bool	goToWarp (const Common::String &warp, bool savePrev=false)

void	returnToWarp ()

void	setCursorDefault (int idx, const Common::String &path)

void	setCursor (const Common::String &path, const Common::String &warp, int idx)

void	hideCursor (const Common::String &warp, int idx)

void	playSound (const Common::String &sound, Audio::Mixer::SoundType type, uint8 volume, int loops, bool spatial=false, float angle=0)

void	stopSound (const Common::String &sound)

void	stopAllSounds ()

void	playMovie (const Common::String &movie)

void	declareVariable (const Common::String &name)

void	setVariable (const Common::String &name, int value)

int	getVariable (const Common::String &name) const

void	executeTest (int idx)

void	scheduleTest (int idx)

void	end ()

void	wait (float seconds)

void	until (const Common::String &var, int value)

const Region *	getRegion (int idx) const

void	resetLockKey ()

void	lockKey (int idx, const Common::String &warp)

void	startTimer (float seconds)

void	pauseTimer (bool pause, bool deactivate)

void	killTimer ()

void	playAnimation (const Common::String &name, const Common::String &var, int varValue, float speed)

void	stopAnimation (const Common::String &name)

void	setZoom (int fov)

void	setXMax (float max)

void	setYMax (float min, float max)

void	resetYMax ()

void	setAngle (float x, float y)

bool	testSaveSlot (int idx) const

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

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

void	drawSlot (int idx, int face, int x, int y)

void	captureContext ()

void	setContextLabel (const Common::String &contextLabel)

bool	enterScript ()

bool	isLoading () const

void	saveVariables ()

void	loadVariables ()

void	rollover (int textId, RolloverType type)

void	showWaves ()

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

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)

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

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

void	defaultSyncSoundSettings ()

virtual void	pauseEngineIntern (bool pause)

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

◆ getGameId()

Common::String PhoenixVR::PhoenixVREngine::getGameId ( ) const

Returns the game Id

◆ getRandomNumber()

uint32 PhoenixVR::PhoenixVREngine::getRandomNumber ( uint maxNum )

inline

Gets a random number

◆ hasFeature()

bool PhoenixVR::PhoenixVREngine::hasFeature ( EngineFeature f ) const

inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ getAutosaveSlot()

int PhoenixVR::PhoenixVREngine::getAutosaveSlot ( ) const

inlineoverridevirtual

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.

◆ canLoadGameStateCurrently()

bool PhoenixVR::PhoenixVREngine::canLoadGameStateCurrently ( Common::U32String * msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool PhoenixVR::PhoenixVREngine::canSaveGameStateCurrently ( Common::U32String * msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ syncSoundSettings()

void PhoenixVR::PhoenixVREngine::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.

◆ loadGameStream()

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

◆ saveGameStream()

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

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

engines/phoenixvr/phoenixvr.h

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ getGameId()

◆ getRandomNumber()

◆ hasFeature()

◆ getAutosaveSlot()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()

◆ syncSoundSettings()

◆ loadGameStream()

◆ saveGameStream()