ScummVM API documentation
Voyeur::VoyeurEngine Class Reference
Inheritance diagram for Voyeur::VoyeurEngine:
Engine

Public Member Functions

 VoyeurEngine (OSystem *syst, const VoyeurGameDescription *gameDesc)
 
void GUIError (const Common::String &msg)
 
uint32 getFeatures () const
 
Common::Language getLanguage () const
 
Common::Platform getPlatform () const
 
uint16 getVersion () const
 
bool getIsDemo () const
 
int getRandomNumber (int maxNumber)
 
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 loadGame (int slot)
 
void playRL2Video (const Common::Path &filename)
 
void doTransitionCard (const Common::String &time, const Common::String &location)
 
void playAVideo (int videoId)
 
void playAVideoDuration (int videoId, int duration)
 
void playAudio (int audioId)
 
void makeViewFinder ()
 
void makeViewFinderP ()
 
void initIFace ()
 
void checkTransition ()
 
int doComputerText (int maxLen)
 
void getComputerBrush ()
 
void doTimeBar ()
 
void flashTimeBar ()
 
void doScroll (const Common::Point &pt)
 
void checkPhoneCall ()
 
void doEvidDisplay (int evidId, int eventId)
 
void flipPageAndWait ()
 
void flipPageAndWaitForFade ()
 
Common::String getDayName ()
 
Common::String getTimeOfDay ()
 
void showEndingNews ()
 
- Public Member Functions inherited from Engine
MetaEnginegetMetaEngine () const
 
void setMetaEngine (MetaEngine *metaEngine)
 
PauseToken pauseEngine ()
 
bool isPaused () const
 
void openMainMenuDialog ()
 
uint32 getTotalPlayTime () const
 
void setTotalPlayTime (uint32 time=0)
 
Common::TimerManagergetTimerManager ()
 
Common::EventManagergetEventManager ()
 
Common::SaveFileManagergetSaveFileManager ()
 
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::DebuggergetDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::DebuggergetOrCreateDebugger ()
 
bool enhancementEnabled (int32 cls)
 
virtual void syncSoundSettings ()
 
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

BoltFile_bVoy
 
Debugger_debugger
 
EventsManager_eventsManager
 
FilesManager_filesManager
 
Screen_screen
 
SoundManager_soundManager
 
SVoy_voy
 
BoltFile_stampLibPtr
 
BoltGroup_controlGroupPtr
 
ControlResource_controlPtr
 
byte * _stampData
 
BoltGroup_stackGroupPtr
 
int _glGoState
 
int _glGoStack
 
int _stampFlags
 
int _playStampGroupId
 
int _currentVocId
 
int _audioVideoId
 
const int * _resolvePtr
 
int _iForceDeath
 
int _checkTransitionId
 
int _gameHour
 
int _gameMinute
 
int _flashTimeVal
 
bool _flashTimeFlag
 
int _timeBarVal
 
int _checkPhoneVal
 
Common::Point _mansionViewPos
 
ThreadResource_mainThread
 
VoyeurArea _voyeurArea
 
int _loadGameSlot
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

Common::Error run () override
 
bool hasFeature (EngineFeature f) const override
 
- 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 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

◆ run()

Common::Error Voyeur::VoyeurEngine::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Voyeur::VoyeurEngine::hasFeature ( EngineFeature  f) const
overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Voyeur::VoyeurEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Voyeur::VoyeurEngine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ loadGameState()

Common::Error Voyeur::VoyeurEngine::loadGameState ( int  slot)
overridevirtual

Load a game state.

Parameters
slotThe slot from which a save state should be loaded.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ saveGameState()

Common::Error Voyeur::VoyeurEngine::saveGameState ( int  slot,
const Common::String desc,
bool  isAutosave = false 
)
overridevirtual

Save a game state.

Parameters
slotThe slot into which the save state should be stored.
descDescription for the save state, entered by the user.
isAutosaveExpected to be true if an autosave is being created.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ playAVideo()

void Voyeur::VoyeurEngine::playAVideo ( int  videoId)

Play a given video

◆ playAVideoDuration()

void Voyeur::VoyeurEngine::playAVideoDuration ( int  videoId,
int  duration 
)

Play a given video for a given amount of time. This is particularly used for later tape playback, where it will only play back as much of the video as the user originally watched (since they can break out of watching a video).

◆ playAudio()

void Voyeur::VoyeurEngine::playAudio ( int  audioId)

Play an audio sequence

◆ doTimeBar()

void Voyeur::VoyeurEngine::doTimeBar ( )

Displays the time/charge remaining on the video camera screen

◆ flashTimeBar()

void Voyeur::VoyeurEngine::flashTimeBar ( )

If necessary, flashes the time remaining bar on the video camera screen

◆ doScroll()

void Voyeur::VoyeurEngine::doScroll ( const Common::Point pt)

Handle scrolling of the mansion view in the camera sights

◆ checkPhoneCall()

void Voyeur::VoyeurEngine::checkPhoneCall ( )

Check for phone call

◆ doEvidDisplay()

void Voyeur::VoyeurEngine::doEvidDisplay ( int  evidId,
int  eventId 
)

Display evidence sequence from within a room Suspension of disbelief needed to believe that recording from a distance, you could still flip through the often pages of evidence for a single hotspot.

◆ flipPageAndWait()

void Voyeur::VoyeurEngine::flipPageAndWait ( )

Flips the active page and waits until it's drawn

◆ flipPageAndWaitForFade()

void Voyeur::VoyeurEngine::flipPageAndWaitForFade ( )

Flips the active page and waits until it's drawn and faded in

◆ getDayName()

Common::String Voyeur::VoyeurEngine::getDayName ( )

Returns the string for the current in-game day of the week

◆ getTimeOfDay()

Common::String Voyeur::VoyeurEngine::getTimeOfDay ( )

Returns the string for the current in-game time of day

◆ showEndingNews()

void Voyeur::VoyeurEngine::showEndingNews ( )

Show the ending sequence of the arrest


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