thirdparty/scummvm
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

VOYEUR: Added method comments for SVoy and some of VoyeurEngine class methods

Browse source
This commit is contained in:
Paul Gilbert 2014-02-01 15:18:27 -05:00
parent 971fd6304f
commit 10f9c2fb03
2 changed files with 61 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

52
engines/voyeur/data.h
View file

@ -129,16 +129,6 @@ public:
int _field4F0; int _field4F0;
int _field4F2; int _field4F2;
/**
* Total number of game events that have occurred
*/
int _eventCount;
/**
* List of game events that have occurred
*/
VoyeurEvent _events[TOTAL_EVENTS];
int _field4376; int _field4376;
int _field4378; int _field4378;
int _field437A; int _field437A;
@ -152,6 +142,9 @@ public:
int _curICF1; int _curICF1;
int _fadeICF0; int _fadeICF0;
int _policeEvent; int _policeEvent;
int _eventCount;
VoyeurEvent _events[TOTAL_EVENTS];
public: public:
SVoy(); SVoy();
void setVm(VoyeurEngine *vm); void setVm(VoyeurEngine *vm);
@ -167,15 +160,54 @@ public:
void addEvent(int hour, int minute, VoyeurEventType type, int audioVideoId, void addEvent(int hour, int minute, VoyeurEventType type, int audioVideoId,
int on, int off, int dead); int on, int off, int dead);
/**
* Adds the start of a video event happening
*/
void addVideoEventStart(); void addVideoEventStart();
/**
* Adds the finish of a video event happening
*/
void addVideoEventEnd(); void addVideoEventEnd();
/**
* Adds the start of an audio event happening
*/
void addAudioEventStart(); void addAudioEventStart();
/**
* Adsd the finish of an audio event happening
*/
void addAudioEventEnd(); void addAudioEventEnd();
/**
* Adds the start of an evidence event happening
*/
void addEvidEventStart(int v); void addEvidEventStart(int v);
/**
* Adds the finish of an evidence event happening
*/
void addEvidEventEnd(int totalPages); void addEvidEventEnd(int totalPages);
/**
* Adds the start of a computer event happening
*/
void addComputerEventStart(); void addComputerEventStart();
/**
* Adds the finish of a computer event happening
*/
void addComputerEventEnd(int v); void addComputerEventEnd(int v);
/**
* Review a previously recorded evidence event
*/
void reviewAnEvidEvent(int eventIndex); void reviewAnEvidEvent(int eventIndex);
/**
* Review a previously recorded computer event
*/
void reviewComputerEvent(int eventIndex); void reviewComputerEvent(int eventIndex);
}; };

22
engines/voyeur/voyeur.h
View file

@ -177,9 +177,6 @@ public:
int _playStampGroupId; int _playStampGroupId;
int _currentVocId; int _currentVocId;
/**
* Id for the current video, audio, or evidence scene being viewed
*/
int _audioVideoId; int _audioVideoId;
const int *_resolvePtr; const int *_resolvePtr;
int _iForceDeath; // CHECKME: The original initializes it in ESP_init() int _iForceDeath; // CHECKME: The original initializes it in ESP_init()
@ -259,7 +256,16 @@ public:
*/ */
void doScroll(const Common::Point &pt); void doScroll(const Common::Point &pt);
/**
* Check for phone call
*/
void checkPhoneCall(); void checkPhoneCall();
/**
* 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.
*/
void doEvidDisplay(int evidId, int eventId); void doEvidDisplay(int evidId, int eventId);
/** /**
@ -285,6 +291,9 @@ public:
#define VOYEUR_SAVEGAME_VERSION 1 #define VOYEUR_SAVEGAME_VERSION 1
/**
* Header for Voyeur savegame files
*/
struct VoyeurSavegameHeader { struct VoyeurSavegameHeader {
uint8 _version; uint8 _version;
Common::String _saveName; Common::String _saveName;
@ -293,7 +302,14 @@ struct VoyeurSavegameHeader {
int _saveHour, _saveMinutes; int _saveHour, _saveMinutes;
int _totalFrames; int _totalFrames;
/**
* Read in the header from the specified file
*/
bool read(Common::InSaveFile *f); bool read(Common::InSaveFile *f);
/**
* Write out header information to the specified file
*/
void write(Common::OutSaveFile *f, VoyeurEngine *vm, const Common::String &saveName); void write(Common::OutSaveFile *f, VoyeurEngine *vm, const Common::String &saveName);
}; };