ScummVM API documentation
Private::PrivateEngine Class Reference
Inheritance diagram for Private::PrivateEngine:
Engine

Public Member Functions

 PrivateEngine (OSystem *syst, const ADGameDescription *gd)
 
bool isDemo () const
 
Common::Error run () override
 
void restartGame ()
 
void clearAreas ()
 
void initializePath (const Common::FSNode &gamePath) override
 
Common::SeekableReadStreamloadAssets ()
 
void initFuncs ()
 
void selectPauseGame (Common::Point)
 
void selectMask (Common::Point)
 
void selectExit (Common::Point)
 
void selectLoadGame (Common::Point)
 
void selectSaveGame (Common::Point)
 
void resumeGame ()
 
bool cursorPauseMovie (Common::Point)
 
bool cursorExit (Common::Point)
 
bool cursorMask (Common::Point)
 
bool hasFeature (EngineFeature f) const override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveAutosaveCurrently () override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
void ignoreEvents ()
 
Common::Error loadGameStream (Common::SeekableReadStream *stream) override
 
Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override
 
void syncGameStream (Common::Serializer &s)
 
Common::Path convertPath (const Common::String &)
 
void playVideo (const Common::String &)
 
void skipVideo ()
 
Graphics::SurfacedecodeImage (const Common::String &file, byte **palette)
 
void remapImage (uint16 ncolors, const Graphics::Surface *oldImage, const byte *oldPalette, Graphics::Surface *newImage, const byte *currentPalette)
 
void loadImage (const Common::String &file, int x, int y)
 
void drawScreenFrame (const byte *videoPalette)
 
void changeCursor (const Common::String &)
 
Common::String getInventoryCursor ()
 
Common::String getExitCursor ()
 
Graphics::SurfaceloadMask (const Common::String &, int, int, bool)
 
void drawMask (Graphics::Surface *)
 
void fillRect (uint32, Common::Rect)
 
bool inMask (Graphics::Surface *, Common::Point)
 
void drawScreen ()
 
Common::String getPauseMovieSetting ()
 
Common::String getGoIntroSetting ()
 
Common::String getMainDesktopSetting ()
 
Common::String getPOGoBustMovieSetting ()
 
Common::String getPoliceBustFromMOSetting ()
 
Common::String getAlternateGameVariable ()
 
Common::String getPoliceIndexVariable ()
 
Common::String getWallSafeValueVariable ()
 
bool selectDossierNextSuspect (Common::Point)
 
bool selectDossierPrevSuspect (Common::Point)
 
bool selectDossierNextSheet (Common::Point)
 
bool selectDossierPrevSheet (Common::Point)
 
void loadDossier ()
 
void policeBust ()
 
void startPoliceBust ()
 
void checkPoliceBust ()
 
void loadLocations (const Common::Rect &)
 
void loadInventory (uint32, const Common::Rect &, const Common::Rect &)
 
void playSound (const Common::String &, uint, bool, bool)
 
void stopSound (bool)
 
bool isSoundActive ()
 
Common::String getPaperShuffleSound ()
 
Common::String getTakeSound ()
 
Common::String getTakeLeaveSound ()
 
Common::String getLeaveSound ()
 
Common::String getRandomPhoneClip (const char *, int, int)
 
void selectAMRadioArea (Common::Point)
 
void selectPoliceRadioArea (Common::Point)
 
void selectPhoneArea (Common::Point)
 
void checkPhoneCall ()
 
bool selectSafeDigit (Common::Point)
 
void addSafeDigit (uint32, Common::Rect *)
 
void renderSafeDigit (uint32)
 
bool getRandomBool (uint)
 
bool installTimer (uint32, Common::String *)
 
void removeTimer ()
 
- 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 int getAutosaveSlot () const
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
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 ()
 
virtual void syncSoundSettings ()
 
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 ()
 

Public Attributes

const ADGameDescription_gameDescription
 
Common::Language _language
 
Common::Platform _platform
 
SymbolMaps maps
 
Audio::SoundHandle _fgSoundHandle
 
Audio::SoundHandle _bgSoundHandle
 
Video::SmackerDecoder_videoDecoder
 
Common::InstallShieldV3 _installerArchive
 
NameToPtr _functions
 
Graphics::ManagedSurface_compositeSurface
 
uint32 _transparentColor
 
Common::Rect _screenRect
 
Common::String _framePath
 
Graphics::Surface_frameImage
 
Graphics::Surface_mframeImage
 
byte * _framePalette
 
Common::String _nextVS
 
Common::String _currentVS
 
Common::Point _origin
 
Common::String _nextSetting
 
Common::String _pausedSetting
 
Common::String _currentSetting
 
Common::String _nextMovie
 
Common::String _currentMovie
 
DossierArray _dossiers
 
uint _dossierSuspect
 
uint _dossierPage
 
MaskInfo _dossierNextSuspectMask
 
MaskInfo _dossierPrevSuspectMask
 
MaskInfo _dossierNextSheetMask
 
MaskInfo _dossierPrevSheetMask
 
bool _policeBustEnabled
 
int _numberClicks
 
int _maxNumberClicks
 
int _sirenWarning
 
Common::String _policeBustSetting
 
InvList inventory
 
Common::String _diaryLocPrefix
 
bool _toTake
 
MaskInfo _saveGameMask
 
MaskInfo _loadGameMask
 
int _mode
 
bool _modified
 
PlayedMediaTable _playedMovies
 
PlayedMediaTable _playedPhoneClips
 
Common::String _repeatedMovieExit
 
ExitList _exits
 
MaskList _masks
 
bool _noStopSounds
 
Common::String _globalAudioPath
 
Common::String _sirenSound
 
Common::String _infaceRadioPath
 
MaskInfo _AMRadioArea
 
MaskInfo _policeRadioArea
 
MaskInfo _phoneArea
 
Common::String _phonePrefix
 
Common::String _phoneCallSound
 
SoundList _AMRadio
 
SoundList _policeRadio
 
PhoneList _phone
 
uint32 _safeColor
 
Common::String _safeNumberPath
 
MaskInfo _safeDigitArea [3]
 
Common::Rect _safeDigitRect [3]
 
uint32 _safeDigit [3]
 
- 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
}
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 
static bool shouldQuit ()
 
static MetaEngineDetectiongetMetaEngineDetection ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 
- 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
 

Member Function Documentation

◆ run()

Common::Error Private::PrivateEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ initializePath()

void Private::PrivateEngine::initializePath ( const Common::FSNode gamePath)
overridevirtual

Initialize SearchMan according to the game path.

By default, this adds the directory in non-flat mode with a depth of 4 as priority 0 to SearchMan.

Parameters
gamePathThe base directory of the game data.

Reimplemented from Engine.

◆ hasFeature()

bool Private::PrivateEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Private::PrivateEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveAutosaveCurrently()

bool Private::PrivateEngine::canSaveAutosaveCurrently ( )
inlineoverridevirtual

Indicate whether an autosave can currently be done.

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Private::PrivateEngine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ loadGameStream()

Common::Error Private::PrivateEngine::loadGameStream ( Common::SeekableReadStream stream)
overridevirtual

Load a game state.

Parameters
streamThe stream to load the save state from.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ saveGameStream()

Common::Error Private::PrivateEngine::saveGameStream ( Common::WriteStream stream,
bool  isAutosave = false 
)
overridevirtual

Save a game state.

Parameters
streamThe write stream to save the savegame data to.
isAutosaveExpected 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: