ScummVM
MutationOfJB::MutationOfJBEngine Class Reference

#include <mutationofjb.h>

+ Inheritance diagram for MutationOfJB::MutationOfJBEngine:
+ Collaboration diagram for MutationOfJB::MutationOfJBEngine:

Public Types

enum  CursorState { CURSOR_OFF, CURSOR_IDLE, CURSOR_ACTIVE }
 
- Public Types inherited from Engine
enum  EngineFeature { kSupportsSubtitleOptions, kSupportsRTL, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime }
 A feature in this context means an ability of the engine which can be either available or not. More...
 

Public Member Functions

 MutationOfJBEngine (OSystem *syst, const ADGameDescription *gameDesc)
 
 ~MutationOfJBEngine () override
 
Common::Error run () override
 Init the engine and start its main loop. More...
 
Graphics::ScreengetScreen () const
 
GamegetGame ()
 
void setCursorState (CursorState cursorState)
 
bool hasFeature (EngineFeature f) const override
 Determine whether the engine supports the specified feature. More...
 
bool canLoadGameStateCurrently () override
 Indicates whether a game state can be loaded. More...
 
Common::Error loadGameState (int slot) override
 Load a game state. More...
 
bool canSaveGameStateCurrently () override
 Indicates whether a game state can be saved. More...
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 Save a game state. More...
 
const ADGameDescriptiongetGameDescription () const
 
- Public Member Functions inherited from Engine
 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...
 
void setDebugger (GUI::Debugger *debugger)
 Sets the engine's debugger. More...
 
GUI::DebuggergetOrCreateDebugger ()
 Return the engine's debugger instance, or create one if none is present. 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 flipMute ()
 Flip mute all sound option. More...
 
virtual Common::String getSaveStateName (int slot) const
 Generates the savegame filename. More...
 
virtual Common::Error loadGameStream (Common::SeekableReadStream *stream)
 Load a game state. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 Save a game state. More...
 
bool saveGameDialog ()
 Shows the ScummVM save dialog, allowing users to save their game. More...
 
bool loadGameDialog ()
 Shows the ScummVM Restore dialog, allowing users to load a game. More...
 
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...
 
void handleAutoSave ()
 Checks for whether it's time to do an autosave, and if so, does it. More...
 
void saveAutosaveIfEnabled ()
 Does an autosave immediately if autosaves are turned on. More...
 
virtual bool canSaveAutosaveCurrently ()
 Indicates whether an autosave can currently be saved. More...
 
virtual int getAutosaveSlot () const
 Returns the slot that should be used for autosaves. More...
 
bool shouldPerformAutoSave (int lastSaveTime)
 

Private Member Functions

bool loadGameData (bool partB)
 
void setupCursor ()
 
void updateCursorPalette ()
 

Private Attributes

const ADGameDescription_gameDesc
 
Graphics::Screen_screen
 
Game_game
 
uint8 _mapObjectId
 
CursorState _cursorState
 
GuiScreen_currentScreen
 

Additional Inherited Members

- 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 MetaEnginegetMetaEngine ()
 
static bool warnUserAboutUnsupportedGame ()
 Display a warning to the user that the game is not fully supported. More...
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
virtual void pauseEngineIntern (bool pause)
 Actual implementation of pauseEngine by subclasses. 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 52 of file mutationofjb.h.

Member Enumeration Documentation

◆ CursorState

Enumerator
CURSOR_OFF 
CURSOR_IDLE 
CURSOR_ACTIVE 

Definition at line 54 of file mutationofjb.h.

Constructor & Destructor Documentation

◆ MutationOfJBEngine()

MutationOfJB::MutationOfJBEngine::MutationOfJBEngine ( OSystem syst,
const ADGameDescription gameDesc 
)

Definition at line 46 of file mutationofjb.cpp.

◆ ~MutationOfJBEngine()

MutationOfJB::MutationOfJBEngine::~MutationOfJBEngine ( )
override

Definition at line 59 of file mutationofjb.cpp.

Member Function Documentation

◆ canLoadGameStateCurrently()

bool MutationOfJB::MutationOfJBEngine::canLoadGameStateCurrently ( )
overridevirtual

Indicates whether a game state can be loaded.

Reimplemented from Engine.

Definition at line 123 of file mutationofjb.cpp.

◆ canSaveGameStateCurrently()

bool MutationOfJB::MutationOfJBEngine::canSaveGameStateCurrently ( )
overridevirtual

Indicates whether a game state can be saved.

Reimplemented from Engine.

Definition at line 146 of file mutationofjb.cpp.

◆ getGame()

Game & MutationOfJB::MutationOfJBEngine::getGame ( )

Definition at line 102 of file mutationofjb.cpp.

◆ getGameDescription()

const ADGameDescription * MutationOfJB::MutationOfJBEngine::getGameDescription ( ) const

Definition at line 168 of file mutationofjb.cpp.

◆ getScreen()

Graphics::Screen * MutationOfJB::MutationOfJBEngine::getScreen ( ) const

Definition at line 98 of file mutationofjb.cpp.

◆ hasFeature()

bool MutationOfJB::MutationOfJBEngine::hasFeature ( Engine::EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Definition at line 115 of file mutationofjb.cpp.

◆ loadGameData()

bool MutationOfJB::MutationOfJBEngine::loadGameData ( bool  partB)
private

◆ loadGameState()

Common::Error MutationOfJB::MutationOfJBEngine::loadGameState ( int  slot)
overridevirtual

Load a game state.

Parameters
slotthe slot from which a savestate should be loaded
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Definition at line 127 of file mutationofjb.cpp.

◆ run()

Common::Error MutationOfJB::MutationOfJBEngine::run ( )
overridevirtual

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 172 of file mutationofjb.cpp.

◆ saveGameState()

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

Save a game state.

Parameters
slotthe slot into which the savestate should be stored
desca description for the savestate, entered by the user
isAutosaveExpected to be true if an autosave is being created
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Definition at line 150 of file mutationofjb.cpp.

◆ setCursorState()

void MutationOfJB::MutationOfJBEngine::setCursorState ( CursorState  cursorState)

Definition at line 106 of file mutationofjb.cpp.

◆ setupCursor()

void MutationOfJB::MutationOfJBEngine::setupCursor ( )
private

Definition at line 61 of file mutationofjb.cpp.

◆ updateCursorPalette()

void MutationOfJB::MutationOfJBEngine::updateCursorPalette ( )
private

Definition at line 87 of file mutationofjb.cpp.

Member Data Documentation

◆ _currentScreen

GuiScreen* MutationOfJB::MutationOfJBEngine::_currentScreen
private

Definition at line 87 of file mutationofjb.h.

◆ _cursorState

CursorState MutationOfJB::MutationOfJBEngine::_cursorState
private

Definition at line 86 of file mutationofjb.h.

◆ _game

Game* MutationOfJB::MutationOfJBEngine::_game
private

Definition at line 83 of file mutationofjb.h.

◆ _gameDesc

const ADGameDescription* MutationOfJB::MutationOfJBEngine::_gameDesc
private

Definition at line 81 of file mutationofjb.h.

◆ _mapObjectId

uint8 MutationOfJB::MutationOfJBEngine::_mapObjectId
private

Definition at line 84 of file mutationofjb.h.

◆ _screen

Graphics::Screen* MutationOfJB::MutationOfJBEngine::_screen
private

Definition at line 82 of file mutationofjb.h.


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