ScummVM API documentation
MacVenture::MacVentureEngine Class Reference
Inheritance diagram for MacVenture::MacVentureEngine:
Engine

Public Member Functions

 MacVentureEngine (OSystem *syst, const ADGameDescription *gameDesc)
 
bool hasFeature (EngineFeature f) const override
 
Common::Error run () override
 
bool scummVMSaveLoadDialog (bool isSave)
 
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
 
void newGame ()
 
void setInitialFlags ()
 
void setNewGameState ()
 
void reset ()
 
void resetInternals ()
 
void resetGui ()
 
void refreshScreen ()
 
void loadDataBundle ()
 
Common::SeekableReadStreamgetBorderFile (MVWindowType windowType, bool isActive)
 
void requestQuit ()
 
void requestUnpause ()
 
void selectControl (ControlAction action)
 
void refreshReady ()
 
void preparedToRun ()
 
void gameChanged ()
 
void winGame ()
 
void loseGame ()
 
void clickToContinue ()
 
void updateState (bool pause)
 
void revert ()
 
void enqueueObject (ObjectQueueID type, ObjID objID, ObjID target=0)
 
void enqueueText (TextQueueID type, ObjID target, ObjID source, ObjID text)
 
void enqueueSound (SoundQueueID type, ObjID target)
 
void runObjQueue ()
 
void printTexts ()
 
void playSounds (bool pause)
 
void handleObjectSelect (ObjID objID, WindowReference win, bool shiftPressed, bool isDoubleClick)
 
void handleObjectDrop (ObjID objID, Common::Point delta, ObjID newParent)
 
void setDeltaPoint (Common::Point newPos)
 
void focusObjWin (ObjID objID)
 
void updateWindow (WindowReference winID)
 
bool showTextEntry (ObjID text, ObjID srcObj, ObjID destObj)
 
void setTextInput (const Common::String &content)
 
Common::String getUserInput ()
 
Common::Path getStartGameFileName ()
 
bool isPaused ()
 
bool needsClickToContinue ()
 
Common::String getCommandsPausedString () const
 
const GlobalSettingsgetGlobalSettings () const
 
Common::Path getFilePath (FilePathID id) const
 
bool isOldText () const
 
const HuffmanListsgetDecodingHuffman () const
 
uint32 randBetween (uint32 min, uint32 max)
 
uint32 getInvolvedObjects ()
 
int findObjectInArray (ObjID objID, const Common::Array< ObjID > &list)
 
uint getPrefixNdx (ObjID obj)
 
Common::String getPrefixString (uint flag, ObjID obj)
 
Common::String getNoun (ObjID ndx)
 
Common::Point getObjPosition (ObjID objID)
 
bool isObjVisible (ObjID objID)
 
bool isObjClickable (ObjID objID)
 
bool isObjSelected (ObjID objID)
 
bool isObjExit (ObjID objID)
 
bool isHiddenExit (ObjID objID)
 
Common::Point getObjExitPosition (ObjID objID)
 
ObjID getParent (ObjID objID)
 
ControlAction referenceToAction (ControlType id)
 
Common::Rect getObjBounds (ObjID objID)
 
uint getOverlapPercent (ObjID one, ObjID other)
 
WindowReference getObjWindow (ObjID objID)
 
WindowReference findParentWindow (ObjID objID)
 
Common::Point getDeltaPoint ()
 
ObjID getDestObject ()
 
ControlAction getSelectedControl ()
 
- 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 applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
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 ()
 

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)
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 
- 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

◆ hasFeature()

bool MacVenture::MacVentureEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ run()

Common::Error MacVenture::MacVentureEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ canLoadGameStateCurrently()

bool MacVenture::MacVentureEngine::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 MacVenture::MacVentureEngine::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 MacVenture::MacVentureEngine::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 MacVenture::MacVentureEngine::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.


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