ScummVM API documentation
Mohawk::MohawkEngine_Myst Class Reference
Inheritance diagram for Mohawk::MohawkEngine_Myst:
Mohawk::MohawkEngine Engine

Public Member Functions

 MohawkEngine_Myst (OSystem *syst, const MohawkGameDescription *gamedesc)
 
Common::SeekableReadStreamgetResource (uint32 tag, uint16 id) override
 
Common::Array< uint16 > getResourceIDList (uint32 type) const
 
void cachePreload (uint32 tag, uint16 id)
 
void changeToStack (MystStack stackId, uint16 card, uint16 linkSrcSound, uint16 linkDstSound)
 
void changeToCard (uint16 card, TransitionType transition)
 
MystCardgetCard ()
 
MystCardPtr getCardPtr ()
 
void setMainCursor (uint16 cursor)
 
uint16 getMainCursor ()
 
void refreshCursor ()
 
bool wait (uint32 duration, bool skippable=false)
 
void doFrame ()
 
MystSoundBlock readSoundBlock (Common::ReadStream *stream) const
 
void applySoundBlock (const MystSoundBlock &block)
 
MystArealoadResource (Common::SeekableReadStream *rlstStream, MystArea *parent)
 
void redrawResource (MystAreaImageSwitch *resource, bool update=true)
 
void setCacheState (bool state)
 
bool getCacheState ()
 
VideoEntryPtr playMovie (const Common::String &name, MystStack stack)
 
VideoEntryPtr playMovieFullscreen (const Common::String &name, MystStack stack)
 
VideoEntryPtr findVideo (const Common::String &name, MystStack stack)
 
void playMovieBlocking (const Common::String &name, MystStack stack, uint16 x, uint16 y)
 
void playFlybyMovie (MystStack stack)
 
void playSkippableMovie (const VideoEntryPtr &video, bool looping)
 
void waitUntilMovieEnds (const VideoEntryPtr &video)
 
Common::Path selectLocalizedMovieFilename (const Common::Path &movieName)
 
void playSoundBlocking (uint16 id)
 
bool isInteractive () const
 
bool isGameStarted () const
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
Common::String getSaveStateName (int slot) const override
 
bool hasFeature (EngineFeature f) const override
 
void applyGameSettings () override
 
void resumeFromMainMenu ()
 
void runOptionsDialog ()
 
void runCredits ()
 
bool canDoAction (MystEventAction action)
 
void doAction (MystEventAction action)
 
void scheduleAction (MystEventAction action)
 
Common::Language getLanguage () const override
 
- Public Member Functions inherited from Mohawk::MohawkEngine
 MohawkEngine (OSystem *syst, const MohawkGameDescription *gamedesc)
 
const char * getGameId () const
 
uint32 getFeatures () const
 
bool isGameVariant (MohawkGameFeatures feature) const
 
const char * getAppName () const
 
Common::Platform getPlatform () const
 
uint8 getGameType () const
 
bool hasResource (uint32 tag, uint16 id)
 
bool hasResource (uint32 tag, const Common::String &resName)
 
uint32 getResourceOffset (uint32 tag, uint16 id)
 
uint16 findResourceID (uint32 type, const Common::String &resName)
 
Common::String getResourceName (uint32 tag, uint16 id)
 
void closeAllArchives ()
 
void pauseGame ()
 
- 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 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::DebuggergetDebugger () final
 
void setDebugger (GUI::Debugger *debugger)
 
GUI::DebuggergetOrCreateDebugger ()
 
virtual void syncSoundSettings ()
 
virtual void flipMute ()
 
virtual Common::Error loadGameStream (Common::SeekableReadStream *stream)
 
void setGameToLoadSlot (int slot)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Static Public Member Functions

static Common::Array< Common::Keymap * > initKeymaps (const char *target)
 
static const MystLanguagegetLanguageDesc (Common::Language language)
 
- 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)
 

Public Attributes

bool addCdRomDelay
 
bool _showResourceRects
 
VideoManager_video
 
MystSound_sound
 
MystGraphics_gfx
 
MystGameState_gameState
 
MystScriptParserPtr _stack
 
Common::RandomSource_rnd
 
- Public Attributes inherited from Mohawk::MohawkEngine
const MohawkGameDescription_gameDescription
 
CursorManager_cursor
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

Common::Error run () override
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 
- Protected Attributes inherited from Mohawk::MohawkEngine
Common::Array< Archive * > _mhk
 
- 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 Mohawk::MohawkEngine_Myst::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Reimplemented from Mohawk::MohawkEngine.

◆ doFrame()

void Mohawk::MohawkEngine_Myst::doFrame ( )

Update the game state according to events and update the screen

◆ isInteractive()

bool Mohawk::MohawkEngine_Myst::isInteractive ( ) const

Is the game currently interactive

When the game is interactive, the user can interact with the game world and perform other operations such as loading saved games, ...

◆ canLoadGameStateCurrently()

bool Mohawk::MohawkEngine_Myst::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Mohawk::MohawkEngine_Myst::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ loadGameState()

Common::Error Mohawk::MohawkEngine_Myst::loadGameState ( int  slot)
overridevirtual

Load a game state.

Parameters
slotThe slot from which a save state should be loaded.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ saveGameState()

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

Save a game state.

Parameters
slotThe slot into which the save state should be stored.
descDescription for the save state, entered by the user.
isAutosaveExpected to be true if an autosave is being created.
Returns
kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ getSaveStateName()

Common::String Mohawk::MohawkEngine_Myst::getSaveStateName ( int  slot) const
inlineoverridevirtual

Generate the savegame filename.

Reimplemented from Engine.

◆ hasFeature()

bool Mohawk::MohawkEngine_Myst::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Mohawk::MohawkEngine.

◆ applyGameSettings()

void Mohawk::MohawkEngine_Myst::applyGameSettings ( )
overridevirtual

Notify the engine that the settings editable from the Game tab in the in-game options dialog might have changed and that they need to be applied if necessary.

Reimplemented from Engine.


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