ScummVM API documentation
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Plumbers::PlumbersGame Class Referenceabstract
Inheritance diagram for Plumbers::PlumbersGame:
Engine Plumbers::PlumbersGame3DO Plumbers::PlumbersGameWindows

Public Member Functions

 PlumbersGame (OSystem *syst, const ADGameDescription *gameDesc)
 
Common::Error run () override
 
const char * getGameId () const
 
Common::Platform getPlatform () const
 
- 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 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::Debugger * getDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::Debugger * getOrCreateDebugger ()
 
virtual bool hasFeature (EngineFeature f) const
 
bool enhancementEnabled (int32 cls)
 
virtual void syncSoundSettings ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
virtual Common::Error loadGameState (int slot)
 
virtual Common::Error loadGameStream (Common::SeekableReadStream *stream)
 
void setGameToLoadSlot (int slot)
 
virtual bool canLoadGameStateCurrently (Common::U32String *msg=nullptr)
 
virtual Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
virtual bool canSaveGameStateCurrently (Common::U32String *msg=nullptr)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

const ADGameDescription * _gameDescription
 
int _duration
 
Common::String _filename
 
- Public Attributes inherited from Engine
OSystem * _system
 
Audio::Mixer * _mixer
 

Protected Types

enum  Action {
  Redraw, ShowScene, UpdateScene, ChangeScene,
  PlaySound
}
 

Protected Member Functions

virtual void readTables ()=0
 
virtual void postSceneBitmaps ()=0
 
virtual bool handlePlatformJoyButton (int button)
 
virtual bool handlePlatformKeyDown (int button)
 
virtual void loadImage (const Common::String &name)
 
virtual void startGraphics ()=0
 
void blitImageSurface (const Graphics::Surface *surface)
 
virtual void blitImage ()
 
virtual void handleEvent (const Common::Event &event)
 
virtual int getSceneNumb (const Common::String &sName)
 
virtual void preActions ()
 
void initTables ()
 
void drawScreen ()
 
void playSound (const Common::String &name)
 
void stopSound ()
 
void showScene ()
 
void updateScene ()
 
void changeScene ()
 
void processTimer ()
 
int getMouseHiLite ()
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 
virtual void pauseEngineIntern (bool pause)
 

Static Protected Member Functions

static void onTimer (void *arg)
 

Protected Attributes

struct {
   int   _duration
 
   Common::String   _filename
 
} _bitmaps [kMaxBitmaps]
 
Scene _scenes [kMaxScene]
 
int _totScene
 
long _totScore
 
Graphics::PixelFormat _targetFormat
 
Image::ImageDecoder * _image
 
Console * _console
 
Video::VideoDecoder * _videoDecoder
 
bool _showScoreFl
 
bool _setDurationFl
 
bool _leftButtonDownFl
 
bool _endGameFl
 
bool _timerInstalled
 
int _curSceneIdx
 
int _prvSceneIdx
 
int _curBitmapIdx
 
int _curChoice
 
int _screenW
 
int _screenH
 
bool _quit
 
Common::Queue< Action > _actions
 
Graphics::Surface * _compositeSurface
 
Audio::SoundHandle _soundHandle
 
- Protected Attributes inherited from Engine
Common::TimerManager * _timer
 
Common::EventManager * _eventMan
 
Common::SaveFileManager * _saveFileMan
 
GUI::Dialog * _mainMenuDialog
 
const Common::String _targetName
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Static Protected Attributes

static const int kMaxName = 13 + 1
 
static const int kMaxBitmaps = 2000
 
static const int kMaxScene = 100
 

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)
 

Member Function Documentation

◆ run()

Common::Error Plumbers::PlumbersGame::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

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