ScummVM
Cryo::CryoEngine Class Reference

#include <cryo.h>

+ Inheritance diagram for Cryo::CryoEngine:
+ Collaboration diagram for Cryo::CryoEngine:

Public Member Functions

 CryoEngine (OSystem *syst, const ADGameDescription *gameDesc)
 
 ~CryoEngine () override
 
Common::Error run () override
 Init the engine and start its main loop. More...
 
const char * getGameId () const
 
Common::Platform getPlatform () const
 
bool isDemo () const
 
void pollEvents ()
 
void hideMouse ()
 
void showMouse ()
 
void getMousePosition (int16 *x, int16 *y)
 
void setMousePosition (int16 x, int16 y)
 
bool isMouseButtonDown ()
 
- 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 bool hasFeature (EngineFeature f) const
 Determine whether the engine supports the specified feature. 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 loadGameState (int slot)
 Load a game state. 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 bool canLoadGameStateCurrently ()
 Indicates whether a game state can be loaded. More...
 
virtual Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 Save a game state. More...
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 Save a game state. More...
 
virtual bool canSaveGameStateCurrently ()
 Indicates whether a game state can be saved. 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)
 

Public Attributes

const ADGameDescription_gameDescription
 
Common::RandomSource_rnd
 
Graphics::Surface _screen
 
EdenGame_game
 
HnmPlayer_video
 
View_screenView
 
volatile int32 _timerTicks
 
bool _showHotspots
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Additional Inherited Members

- 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...
 
- 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...
 
- 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 55 of file cryo.h.

Constructor & Destructor Documentation

◆ CryoEngine()

Cryo::CryoEngine::CryoEngine ( OSystem syst,
const ADGameDescription gameDesc 
)

Definition at line 43 of file cryo.cpp.

◆ ~CryoEngine()

Cryo::CryoEngine::~CryoEngine ( )
override

Definition at line 56 of file cryo.cpp.

Member Function Documentation

◆ getGameId()

const char * Cryo::CryoEngine::getGameId ( ) const

Definition at line 33 of file detection.cpp.

◆ getMousePosition()

void Cryo::CryoEngine::getMousePosition ( int16 x,
int16 y 
)

Definition at line 296 of file cryolib.cpp.

◆ getPlatform()

Common::Platform Cryo::CryoEngine::getPlatform ( ) const

Definition at line 35 of file detection.cpp.

◆ hideMouse()

void Cryo::CryoEngine::hideMouse ( )

Definition at line 290 of file cryolib.cpp.

◆ isDemo()

bool Cryo::CryoEngine::isDemo ( ) const

Definition at line 34 of file detection.cpp.

◆ isMouseButtonDown()

bool Cryo::CryoEngine::isMouseButtonDown ( )

Definition at line 305 of file cryolib.cpp.

◆ pollEvents()

void Cryo::CryoEngine::pollEvents ( )

Definition at line 258 of file cryolib.cpp.

◆ run()

Common::Error Cryo::CryoEngine::run ( )
overridevirtual

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 65 of file cryo.cpp.

◆ setMousePosition()

void Cryo::CryoEngine::setMousePosition ( int16  x,
int16  y 
)

Definition at line 301 of file cryolib.cpp.

◆ showMouse()

void Cryo::CryoEngine::showMouse ( )

Definition at line 293 of file cryolib.cpp.

Member Data Documentation

◆ _game

EdenGame* Cryo::CryoEngine::_game

Definition at line 72 of file cryo.h.

◆ _gameDescription

const ADGameDescription* Cryo::CryoEngine::_gameDescription

Definition at line 63 of file cryo.h.

◆ _rnd

Common::RandomSource* Cryo::CryoEngine::_rnd

Definition at line 69 of file cryo.h.

◆ _screen

Graphics::Surface Cryo::CryoEngine::_screen

Definition at line 71 of file cryo.h.

◆ _screenView

View* Cryo::CryoEngine::_screenView

Definition at line 75 of file cryo.h.

◆ _showHotspots

bool Cryo::CryoEngine::_showHotspots

Definition at line 78 of file cryo.h.

◆ _timerTicks

volatile int32 Cryo::CryoEngine::_timerTicks

Definition at line 76 of file cryo.h.

◆ _video

HnmPlayer* Cryo::CryoEngine::_video

Definition at line 73 of file cryo.h.


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