ScummVM API documentation
Director::DirectorEngine Class Reference
Inheritance diagram for Director::DirectorEngine:
Engine

Public Member Functions

 DirectorEngine (OSystem *syst, const DirectorGameDescription *gameDesc)
 
DirectorGameGID getGameGID () const
 
const char * getGameId () const
 
uint16 getDescriptionVersion () const
 
uint16 getVersion () const
 
void setVersion (uint16 version)
 
Common::Platform getPlatform () const
 
Common::Language getLanguage () const
 
uint32 getGameFlags () const
 
Common::String getTargetName ()
 
const char * getExtra ()
 
Common::String getRawEXEName () const
 
Common::String getEXEName () const
 
StartMovie getStartMovie () const
 
void parseOptions ()
 
Graphics::MacWindowManagergetMacWindowManager () const
 
LingogetLingo () const
 
WindowgetStage () const
 
WindowgetCurrentWindow () const
 
WindowgetOrCreateWindow (Common::String &name)
 
void forgetWindow (Window *window)
 
void setCurrentWindow (Window *window)
 
WindowgetCursorWindow () const
 
void setCursorWindow (Window *window)
 
MoviegetCurrentMovie () const
 
void setCurrentMovie (Movie *movie)
 
ArchivegetMainArchive () const
 
void setMainArchive (Archive *archive)
 
Common::String getCurrentPath () const
 
Common::String getCurrentAbsolutePath ()
 
Common::Path getStartupPath () const
 
bool hasFeature (EngineFeature f) const override
 
void addPalette (CastMemberID &id, const byte *palette, int length)
 
bool setPalette (const CastMemberID &id)
 
void setPalette (const byte *palette, uint16 count)
 
void shiftPalette (int startIndex, int endIndex, bool reverse)
 
void syncPalette ()
 
void clearPalettes ()
 
PaletteV4getPalette (const CastMemberID &id)
 
bool hasPalette (const CastMemberID &id)
 
void loadDefaultPalettes ()
 
const Common::HashMap< CastMemberID, PaletteV4 > & getLoadedPalettes ()
 
const Common::HashMap< CastMemberID, PaletteV4 > & getLoaded16Palettes ()
 
const PaletteV4getLoaded4Palette ()
 
const Common::FSNodegetGameDataDir () const
 
const byte * getPalette () const
 
uint16 getPaletteColorCount () const
 
void loadPatterns ()
 
PicturegetTile (int num)
 
const Common::RectgetTileRect (int num)
 
uint32 transformColor (uint32 color)
 
Graphics::MacPatternsgetPatterns ()
 
void setCursor (DirectorCursor type)
 
void draw ()
 
Graphics::PrimitivesgetInkPrimitives ()
 
uint32 getColorBlack ()
 
uint32 getColorWhite ()
 
void loadKeyCodes ()
 
void setMachineType (int machineType)
 
Common::CodePage getPlatformEncoding ()
 
ArchivecreateArchive ()
 
ArchiveopenArchive (const Common::Path &movie)
 
void addArchiveToOpenList (const Common::Path &path)
 
ArchiveloadEXE (const Common::Path &movie)
 
ArchiveloadEXEv3 (Common::SeekableReadStream *stream)
 
ArchiveloadEXEv4 (Common::SeekableReadStream *stream)
 
ArchiveloadEXEv5 (Common::SeekableReadStream *stream)
 
ArchiveloadEXEv7 (Common::SeekableReadStream *stream)
 
ArchiveloadEXERIFX (Common::SeekableReadStream *stream, uint32 offset)
 
ArchiveloadMac (const Common::Path &movie)
 
bool desktopEnabled ()
 
bool pollEvent (Common::Event &event)
 
bool processEvents (bool captureClick=false, bool skipWindowManager=false)
 
void processEventQUIT ()
 
int getMacTicks ()
 
void gameQuirks (const char *target, Common::Platform platform)
 
void loadSlowdownCooloff (uint32 delay=2000)
 
void delayMillis (uint32 delay)
 
const Common::Array< Window * > * getWindowList ()
 
- 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
 
virtual bool gameTypeHasAddOns () const
 
virtual bool dirCanBeGameAddOn (const Common::FSDirectory &dir) const
 
virtual bool dirMustBeGameAddOn (const Common::FSDirectory &dir) const
 
Common::ErrorCode updateAddOns (const MetaEngine *metaEngine) 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 ()
 
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

Common::Array< Common::Event_injectedEvents
 
RandomState _rnd
 
Graphics::MacWindowManager_wm
 
Graphics::PixelFormat _pixelformat
 
uint32 _debugDraw = 0
 
int _defaultVolume = 255
 
int _colorDepth
 
Common::HashMap< int, int > _KeyCodes
 
int _machineType
 
bool _playbackPaused
 
bool _centerStage
 
char _dirSeparator
 
bool _fixStageSize
 
Archive_mainArchive
 
Common::Rect _fixStageRect
 
Common::List< Common::String_extraSearchPath
 
Common::HashMap< Common::Path, Archive *, Common::Path::IgnoreCaseAndMac_Hash, Common::Path::IgnoreCaseAndMac_EqualTo_allSeenResFiles
 
Common::HashMap< Common::Path, Archive *, Common::Path::IgnoreCaseAndMac_Hash, Common::Path::IgnoreCaseAndMac_EqualTo_openResFiles
 
Common::List< Common::Path_allOpenResFiles
 
Common::Array< Graphics::WinCursorGroup * > _winCursor
 
const DirectorGameDescription_gameDescription
 
Common::HashMap< Common::String, Common::String_cachedSaveFiles
 
Common::FSNode _gameDataDir
 
CastMemberID_clipBoard
 
uint32 _wmMode
 
uint16 _wmWidth
 
uint16 _wmHeight
 
CastMemberID _lastPalette
 
byte _fpsLimit
 
TimeDate _forceDate
 
uint32 _loadSlowdownFactor
 
uint32 _loadSlowdownCooldownTime
 
int _fileIOType
 
int _tickBaseline
 
Common::Path _traceLogFile
 
uint16 _framesRan = 0
 
bool _noFatalLingoError = false
 
bool _firstMovie = true
 
- 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 ()
 
virtual void pauseEngineIntern (bool pause)
 

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 bool warnUserAboutUnsupportedAddOn (Common::String addOnName)
 
static void errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)
 
static void errorUnsupportedGame (Common::String extraMsg)
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Member Function Documentation

◆ hasFeature()

bool Director::DirectorEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ run()

Common::Error Director::DirectorEngine::run ( )
overrideprotectedvirtual

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: