ScummVM
Voyeur::VoyeurEngine Class Reference

#include <voyeur.h>

Inheritance diagram for Voyeur::VoyeurEngine:
Collaboration diagram for Voyeur::VoyeurEngine:

Public Member Functions

 VoyeurEngine (OSystem *syst, const VoyeurGameDescription *gameDesc)
 
virtual ~VoyeurEngine ()
 
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)
 
Common::String generateSaveName (int slotNumber)
 
virtual bool canLoadGameStateCurrently ()
 Returns true if it is currently okay to restore a game. More...
 
virtual bool canSaveGameStateCurrently ()
 Returns true if it is currently okay to save the game. More...
 
virtual Common::Error loadGameState (int slot)
 Load the savegame at the specified slot index. More...
 
virtual Common::Error saveGameState (int slot, const Common::String &desc)
 Save the game to the given slot index, and with the given name. More...
 
void loadGame (int slot)
 
void playRL2Video (const Common::String &filename)
 
void doTransitionCard (const Common::String &time, const Common::String &location)
 
void playAVideo (int videoId)
 Play a given video. More...
 
void playAVideoDuration (int videoId, int duration)
 Play a given video for a given amount of time. More...
 
void playAudio (int audioId)
 Play an audio sequence. More...
 
void saveLastInplay ()
 Saves the last time the game was played. More...
 
void makeViewFinder ()
 
void makeViewFinderP ()
 
void initIFace ()
 
void checkTransition ()
 
int doComputerText (int maxLen)
 
void getComputerBrush ()
 
void doTimeBar ()
 Displays the time/charge remaining on the video camera screen. More...
 
void flashTimeBar ()
 If necessary, flashes the time remaining bar on the video camera screen. More...
 
void doScroll (const Common::Point &pt)
 Handle scrolling of the mansion view in the camera sights. More...
 
void checkPhoneCall ()
 Check for phone call. More...
 
void 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. More...
 
void flipPageAndWait ()
 Flips the active page and waits until it's drawn. More...
 
void flipPageAndWaitForFade ()
 Flips the active page and waits until it's drawn and faded in. More...
 
Common::String getDayName ()
 Returns the string for the current in-game day of the week. More...
 
Common::String getTimeOfDay ()
 Returns the string for the current in-game time of day. More...
 
void showEndingNews ()
 Show the ending sequence of the arrest. More...
 
- Public Member Functions inherited from Engine
void pauseEngine (bool pause)
 Pause or resume the engine. More...
 
bool isPaused () const
 Return whether the engine is currently paused or not. More...
 
void openMainMenuDialog ()
 Run the Global Main Menu Dialog. More...
 
uint32 getTotalPlayTime () const
 Get the total play time. More...
 
void setTotalPlayTime (uint32 time=0)
 Set the game time counter to the specified time. More...
 
Common::TimerManagergetTimerManager ()
 
Common::EventManagergetEventManager ()
 
Common::SaveFileManagergetSaveFileManager ()
 
void checkCD ()
 On some systems, check if the game appears to be run from CD. More...
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
virtual void initializePath (const Common::FSNode &gamePath)
 Init SearchMan according to the game path. More...
 
virtual void errorString (const char *buf_input, char *buf_output, int buf_output_size)
 Prepare an error string, which is printed by the error() function. More...
 
virtual GUI::DebuggergetDebugger ()
 Return the engine's debugger instance, if any. More...
 
virtual void syncSoundSettings ()
 Notify the engine that the sound settings in the config manager may have changed and that it hence should adjust any internal volume etc. More...
 
virtual void initKeymap ()
 
virtual void deinitKeymap ()
 
virtual void flipMute ()
 Flip mute all sound option. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 

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

virtual Common::Error run ()
 Init the engine and start its main loop. More...
 
virtual bool hasFeature (EngineFeature f) const
 Determine whether the engine supports the specified feature. More...
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
bool shouldPerformAutoSave (int lastSaveTime)
 Indicate whether an autosave should be performed. More...
 
virtual void pauseEngineIntern (bool pause)
 Actual implementation of pauseEngine by subclasses. More...
 

Private Member Functions

void ESP_Init ()
 
void globalInitBolt ()
 
void initBolt ()
 
void vInitInterrupts ()
 
void initInput ()
 
bool doHeadTitle ()
 
void showConversionScreen ()
 
bool doLock ()
 
void showTitleScreen ()
 
void doOpening ()
 
void playStamp ()
 
void initStamp ()
 
void closeStamp ()
 
void doTailTitle ()
 Shows the game ending title animation. More...
 
void doClosingCredits ()
 Shows the game ending credits. More...
 
void doPiracy ()
 Shows the final anti-piracy message before exiting the game. More...
 
void reviewTape ()
 Review previous tape recordings on the TV. More...
 
void doGossip ()
 Shows the TV gossip animation. More...
 
void doTapePlaying ()
 Shows the animation of the VCR tape during the 'Call the Police' sequence. More...
 
bool checkForMurder ()
 Does a check as to whether a murder has been witnessed. More...
 
bool checkForIncriminate ()
 Does a check for whether incriminating evidence has been revealed. More...
 
void playAVideoEvent (int eventIndex)
 Plays a video event previously witnessed. More...
 
int getChooseButton ()
 Shows the user a screen to select one of four characters to send the video tape to. More...
 
void synchronize (Common::Serializer &s)
 Synchronizes the game data. More...
 
void centerMansionView ()
 Resets the mansion view position. More...
 

Private Attributes

const VoyeurGameDescription_gameDescription
 
Common::RandomSource _randomSource
 
FontInfoResource _defaultFontInfo
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsRTL, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsJoystick
}
 A feature in this context means an ability of the engine which can be either available or not. More...
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 Request the engine to quit. More...
 
static bool shouldQuit ()
 Return whether the ENGINE should quit respectively should return to the launcher. More...
 
static bool warnUserAboutUnsupportedGame ()
 Display a warning to the user that the game is not fully supported. More...
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 

Detailed Description

Definition at line 76 of file voyeur.h.

Constructor & Destructor Documentation

◆ VoyeurEngine()

Voyeur::VoyeurEngine::VoyeurEngine ( OSystem syst,
const VoyeurGameDescription gameDesc 
)

Definition at line 36 of file voyeur.cpp.

◆ ~VoyeurEngine()

Voyeur::VoyeurEngine::~VoyeurEngine ( )
virtual

Definition at line 80 of file voyeur.cpp.

Member Function Documentation

◆ canLoadGameStateCurrently()

bool Voyeur::VoyeurEngine::canLoadGameStateCurrently ( )
virtual

Returns true if it is currently okay to restore a game.

Reimplemented from Engine.

Definition at line 755 of file voyeur.cpp.

◆ canSaveGameStateCurrently()

bool Voyeur::VoyeurEngine::canSaveGameStateCurrently ( )
virtual

Returns true if it is currently okay to save the game.

Reimplemented from Engine.

Definition at line 762 of file voyeur.cpp.

◆ centerMansionView()

void Voyeur::VoyeurEngine::centerMansionView ( )
private

Resets the mansion view position.

Definition at line 1429 of file voyeur_game.cpp.

◆ checkForIncriminate()

bool Voyeur::VoyeurEngine::checkForIncriminate ( )
private

Does a check for whether incriminating evidence has been revealed.

Definition at line 868 of file voyeur_game.cpp.

◆ checkForMurder()

bool Voyeur::VoyeurEngine::checkForMurder ( )
private

Does a check as to whether a murder has been witnessed.

Definition at line 816 of file voyeur_game.cpp.

◆ checkPhoneCall()

void Voyeur::VoyeurEngine::checkPhoneCall ( )

Check for phone call.

Definition at line 1323 of file voyeur_game.cpp.

◆ checkTransition()

void Voyeur::VoyeurEngine::checkTransition ( )

Definition at line 1126 of file voyeur_game.cpp.

◆ closeStamp()

void Voyeur::VoyeurEngine::closeStamp ( )
private

Definition at line 232 of file voyeur_game.cpp.

◆ doClosingCredits()

void Voyeur::VoyeurEngine::doClosingCredits ( )
private

Shows the game ending credits.

Definition at line 281 of file voyeur_game.cpp.

◆ doComputerText()

int Voyeur::VoyeurEngine::doComputerText ( int  maxLen)

Definition at line 1173 of file voyeur_game.cpp.

◆ 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.

Definition at line 1343 of file voyeur_game.cpp.

◆ doGossip()

void Voyeur::VoyeurEngine::doGossip ( )
private

Shows the TV gossip animation.

Definition at line 743 of file voyeur_game.cpp.

◆ doHeadTitle()

bool Voyeur::VoyeurEngine::doHeadTitle ( )
private

Definition at line 159 of file voyeur.cpp.

◆ doLock()

bool Voyeur::VoyeurEngine::doLock ( )
private

Definition at line 243 of file voyeur.cpp.

◆ doOpening()

void Voyeur::VoyeurEngine::doOpening ( )
private

Definition at line 435 of file voyeur.cpp.

◆ doPiracy()

void Voyeur::VoyeurEngine::doPiracy ( )
private

Shows the final anti-piracy message before exiting the game.

Definition at line 390 of file voyeur_game.cpp.

◆ doScroll()

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

Handle scrolling of the mansion view in the camera sights.

Definition at line 1086 of file voyeur_game.cpp.

◆ doTailTitle()

void Voyeur::VoyeurEngine::doTailTitle ( )
private

Shows the game ending title animation.

Definition at line 236 of file voyeur_game.cpp.

◆ doTapePlaying()

void Voyeur::VoyeurEngine::doTapePlaying ( )
private

Shows the animation of the VCR tape during the 'Call the Police' sequence.

Definition at line 789 of file voyeur_game.cpp.

◆ doTimeBar()

void Voyeur::VoyeurEngine::doTimeBar ( )

Displays the time/charge remaining on the video camera screen.

Definition at line 1280 of file voyeur_game.cpp.

◆ doTransitionCard()

void Voyeur::VoyeurEngine::doTransitionCard ( const Common::String time,
const Common::String location 
)

Definition at line 637 of file voyeur.cpp.

◆ ESP_Init()

void Voyeur::VoyeurEngine::ESP_Init ( )
private

Definition at line 114 of file voyeur.cpp.

◆ flashTimeBar()

void Voyeur::VoyeurEngine::flashTimeBar ( )

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

Definition at line 1306 of file voyeur_game.cpp.

◆ flipPageAndWait()

void Voyeur::VoyeurEngine::flipPageAndWait ( )

Flips the active page and waits until it's drawn.

Definition at line 677 of file voyeur.cpp.

◆ flipPageAndWaitForFade()

void Voyeur::VoyeurEngine::flipPageAndWaitForFade ( )

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

Definition at line 683 of file voyeur.cpp.

◆ generateSaveName()

Common::String Voyeur::VoyeurEngine::generateSaveName ( int  slotNumber)

Definition at line 748 of file voyeur.cpp.

◆ getChooseButton()

int Voyeur::VoyeurEngine::getChooseButton ( )
private

Shows the user a screen to select one of four characters to send the video tape to.

Definition at line 937 of file voyeur_game.cpp.

◆ getComputerBrush()

void Voyeur::VoyeurEngine::getComputerBrush ( )

Definition at line 1266 of file voyeur_game.cpp.

◆ getDayName()

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

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

Definition at line 1150 of file voyeur_game.cpp.

◆ getFeatures()

uint32 Voyeur::VoyeurEngine::getFeatures ( ) const

Definition at line 42 of file detection.cpp.

◆ getIsDemo()

bool Voyeur::VoyeurEngine::getIsDemo ( ) const

Definition at line 54 of file detection.cpp.

◆ getLanguage()

Common::Language Voyeur::VoyeurEngine::getLanguage ( ) const

Definition at line 46 of file detection.cpp.

◆ getPlatform()

Common::Platform Voyeur::VoyeurEngine::getPlatform ( ) const

Definition at line 50 of file detection.cpp.

◆ getRandomNumber()

int Voyeur::VoyeurEngine::getRandomNumber ( int  maxNumber)

Definition at line 110 of file voyeur.cpp.

◆ getTimeOfDay()

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

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

Definition at line 1166 of file voyeur_game.cpp.

◆ getVersion()

uint16 Voyeur::VoyeurEngine::getVersion ( ) const

◆ globalInitBolt()

void Voyeur::VoyeurEngine::globalInitBolt ( )
private

Definition at line 121 of file voyeur.cpp.

◆ GUIError()

void Voyeur::VoyeurEngine::GUIError ( const Common::String msg)

◆ hasFeature()

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

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Definition at line 103 of file detection.cpp.

◆ initBolt()

void Voyeur::VoyeurEngine::initBolt ( )
private

Definition at line 145 of file voyeur.cpp.

◆ initIFace()

void Voyeur::VoyeurEngine::initIFace ( )

Definition at line 1045 of file voyeur_game.cpp.

◆ initInput()

void Voyeur::VoyeurEngine::initInput ( )
private

Definition at line 156 of file voyeur.cpp.

◆ initStamp()

void Voyeur::VoyeurEngine::initStamp ( )
private

Definition at line 222 of file voyeur_game.cpp.

◆ loadGame()

void Voyeur::VoyeurEngine::loadGame ( int  slot)

Definition at line 774 of file voyeur.cpp.

◆ loadGameState()

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

Load the savegame at the specified slot index.

Reimplemented from Engine.

Definition at line 769 of file voyeur.cpp.

◆ makeViewFinder()

void Voyeur::VoyeurEngine::makeViewFinder ( )

Definition at line 992 of file voyeur_game.cpp.

◆ makeViewFinderP()

void Voyeur::VoyeurEngine::makeViewFinderP ( )

Definition at line 1041 of file voyeur_game.cpp.

◆ playAudio()

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

Play an audio sequence.

Definition at line 604 of file voyeur.cpp.

◆ playAVideo()

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

Play a given video.

Definition at line 541 of file voyeur.cpp.

◆ 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).

Definition at line 545 of file voyeur.cpp.

◆ playAVideoEvent()

void Voyeur::VoyeurEngine::playAVideoEvent ( int  eventIndex)
private

Plays a video event previously witnessed.

Definition at line 912 of file voyeur_game.cpp.

◆ playRL2Video()

void Voyeur::VoyeurEngine::playRL2Video ( const Common::String filename)

Definition at line 520 of file voyeur.cpp.

◆ playStamp()

void Voyeur::VoyeurEngine::playStamp ( )
private

Definition at line 29 of file voyeur_game.cpp.

◆ reviewTape()

void Voyeur::VoyeurEngine::reviewTape ( )
private

Review previous tape recordings on the TV.

Definition at line 421 of file voyeur_game.cpp.

◆ run()

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

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 90 of file voyeur.cpp.

◆ saveGameState()

Common::Error Voyeur::VoyeurEngine::saveGameState ( int  slot,
const Common::String desc 
)
virtual

Save the game to the given slot index, and with the given name.

Reimplemented from Engine.

Definition at line 808 of file voyeur.cpp.

◆ saveLastInplay()

void Voyeur::VoyeurEngine::saveLastInplay ( )

Saves the last time the game was played.

Definition at line 673 of file voyeur.cpp.

◆ showConversionScreen()

void Voyeur::VoyeurEngine::showConversionScreen ( )
private

Definition at line 215 of file voyeur.cpp.

◆ showEndingNews()

void Voyeur::VoyeurEngine::showEndingNews ( )

Show the ending sequence of the arrest.

Definition at line 690 of file voyeur.cpp.

◆ showTitleScreen()

void Voyeur::VoyeurEngine::showTitleScreen ( )
private

Definition at line 392 of file voyeur.cpp.

◆ synchronize()

void Voyeur::VoyeurEngine::synchronize ( Common::Serializer s)
private

Synchronizes the game data.

Definition at line 831 of file voyeur.cpp.

◆ vInitInterrupts()

void Voyeur::VoyeurEngine::vInitInterrupts ( )
private

Definition at line 152 of file voyeur.cpp.

Member Data Documentation

◆ _audioVideoId

int Voyeur::VoyeurEngine::_audioVideoId

Definition at line 182 of file voyeur.h.

◆ _bVoy

BoltFile* Voyeur::VoyeurEngine::_bVoy

Definition at line 163 of file voyeur.h.

◆ _checkPhoneVal

int Voyeur::VoyeurEngine::_checkPhoneVal

Definition at line 191 of file voyeur.h.

◆ _checkTransitionId

int Voyeur::VoyeurEngine::_checkTransitionId

Definition at line 185 of file voyeur.h.

◆ _controlGroupPtr

BoltGroup* Voyeur::VoyeurEngine::_controlGroupPtr

Definition at line 172 of file voyeur.h.

◆ _controlPtr

ControlResource* Voyeur::VoyeurEngine::_controlPtr

Definition at line 173 of file voyeur.h.

◆ _currentVocId

int Voyeur::VoyeurEngine::_currentVocId

Definition at line 180 of file voyeur.h.

◆ _debugger

Debugger* Voyeur::VoyeurEngine::_debugger

Definition at line 164 of file voyeur.h.

◆ _defaultFontInfo

FontInfoResource Voyeur::VoyeurEngine::_defaultFontInfo
private

Definition at line 80 of file voyeur.h.

◆ _eventsManager

EventsManager* Voyeur::VoyeurEngine::_eventsManager

Definition at line 165 of file voyeur.h.

◆ _filesManager

FilesManager* Voyeur::VoyeurEngine::_filesManager

Definition at line 166 of file voyeur.h.

◆ _flashTimeFlag

bool Voyeur::VoyeurEngine::_flashTimeFlag

Definition at line 189 of file voyeur.h.

◆ _flashTimeVal

int Voyeur::VoyeurEngine::_flashTimeVal

Definition at line 188 of file voyeur.h.

◆ _gameDescription

const VoyeurGameDescription* Voyeur::VoyeurEngine::_gameDescription
private

Definition at line 78 of file voyeur.h.

◆ _gameHour

int Voyeur::VoyeurEngine::_gameHour

Definition at line 186 of file voyeur.h.

◆ _gameMinute

int Voyeur::VoyeurEngine::_gameMinute

Definition at line 187 of file voyeur.h.

◆ _glGoStack

int Voyeur::VoyeurEngine::_glGoStack

Definition at line 177 of file voyeur.h.

◆ _glGoState

int Voyeur::VoyeurEngine::_glGoState

Definition at line 176 of file voyeur.h.

◆ _iForceDeath

int Voyeur::VoyeurEngine::_iForceDeath

Definition at line 184 of file voyeur.h.

◆ _loadGameSlot

int Voyeur::VoyeurEngine::_loadGameSlot

Definition at line 195 of file voyeur.h.

◆ _mainThread

ThreadResource* Voyeur::VoyeurEngine::_mainThread

Definition at line 193 of file voyeur.h.

◆ _mansionViewPos

Common::Point Voyeur::VoyeurEngine::_mansionViewPos

Definition at line 192 of file voyeur.h.

◆ _playStampGroupId

int Voyeur::VoyeurEngine::_playStampGroupId

Definition at line 179 of file voyeur.h.

◆ _randomSource

Common::RandomSource Voyeur::VoyeurEngine::_randomSource
private

Definition at line 79 of file voyeur.h.

◆ _resolvePtr

const int* Voyeur::VoyeurEngine::_resolvePtr

Definition at line 183 of file voyeur.h.

◆ _screen

Screen* Voyeur::VoyeurEngine::_screen

Definition at line 167 of file voyeur.h.

◆ _soundManager

SoundManager* Voyeur::VoyeurEngine::_soundManager

Definition at line 168 of file voyeur.h.

◆ _stackGroupPtr

BoltGroup* Voyeur::VoyeurEngine::_stackGroupPtr

Definition at line 175 of file voyeur.h.

◆ _stampData

byte* Voyeur::VoyeurEngine::_stampData

Definition at line 174 of file voyeur.h.

◆ _stampFlags

int Voyeur::VoyeurEngine::_stampFlags

Definition at line 178 of file voyeur.h.

◆ _stampLibPtr

BoltFile* Voyeur::VoyeurEngine::_stampLibPtr

Definition at line 171 of file voyeur.h.

◆ _timeBarVal

int Voyeur::VoyeurEngine::_timeBarVal

Definition at line 190 of file voyeur.h.

◆ _voy

SVoy* Voyeur::VoyeurEngine::_voy

Definition at line 169 of file voyeur.h.

◆ _voyeurArea

VoyeurArea Voyeur::VoyeurEngine::_voyeurArea

Definition at line 194 of file voyeur.h.


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