ScummVM API documentation
Access::AccessEngine Class Referenceabstract
Inheritance diagram for Access::AccessEngine:
Engine Access::Amazon::AmazonEngine Access::Martian::MartianEngine

Public Member Functions

 AccessEngine (OSystem *syst, const AccessGameDescription *gameDesc)
 
virtual void dead (int deathId)=0
 
uint32 getFeatures () const
 
bool isCD () const
 
bool isDemo () const
 
Common::Language getLanguage () const
 
Common::Platform getPlatform () const
 
uint16 getVersion () const
 
uint32 getGameID () const
 
uint32 getGameFeatures () const
 
bool shouldQuitOrRestart ()
 
int getRandomNumber (int maxNumber)
 
void loadCells (Common::Array< CellIdent > &cells)
 
void freeCells ()
 
virtual void establish (int esatabIndex, int sub)=0
 
void plotList ()
 
void plotList1 ()
 
void copyBlocks ()
 
void copyRects ()
 
void copyBF1BF2 ()
 
void copyBF2Vid ()
 
void freeChar ()
 
void printText (BaseSurface *s, const Common::String &msg)
 
void speakText (BaseSurface *s, const Common::String &msg)
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
void writeSavegameHeader (Common::OutSaveFile *out, AccessSavegameHeader &header)
 
void SPRINTCHR (char c, int fontNum)
 
void PRINTCHR (Common::String msg, int fontNum)
 
bool playMovie (const Common::Path &filename, const Common::Point &pos)
 
- 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 ()
 
bool enhancementEnabled (int32 cls)
 
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 ()
 

Static Public Member Functions

static WARN_UNUSED_RESULT bool readSavegameHeader (Common::InSaveFile *in, AccessSavegameHeader &header, bool skipThumbnail=true)
 
- Static Public Member Functions inherited from Engine
static void quitGame ()
 
static bool shouldQuit ()
 
static bool warnUserAboutUnsupportedGame (Common::String msg=Common::String())
 
static void errorUnsupportedGame (Common::String extraMsg)
 

Public Attributes

AnimationManager_animation
 
BubbleBox_bubbleBox
 
BubbleBox_helpBox
 
BubbleBox_travelBox
 
BubbleBox_invBox
 
BubbleBox_aboutBox
 
CharManager_char
 
EventsManager_events
 
FileManager_files
 
InventoryManager_inventory
 
Player_player
 
Resources_res
 
Room_room
 
Screen_screen
 
Scripts_scripts
 
SoundManager_sound
 
MusicManager_midi
 
VideoPlayer_video
 
BaseSurface_destIn
 
BaseSurface_current
 
ASurface _buffer1
 
ASurface _buffer2
 
ASurface _vidBuf
 
int _vidX
 
int _vidY
 
Common::Array< CharEntry * > _charTable
 
SpriteResource_objectsTable [100]
 
bool _establishTable [100]
 
bool _establishFlag
 
int _establishMode
 
int _establishGroup
 
int _establishCtrlTblOfs
 
int _numAnimTimers
 
TimerList _timers
 
DeathList _deaths
 
FontManager _fonts
 
Common::Array< Common::Rect_newRects
 
Common::Array< Common::Rect_oldRects
 
Common::Array< ExtraCell_extraCells
 
ImageEntryList _images
 
int _mouseMode
 
uint8 _playerDataCount
 
int _currentManOld
 
int _converseMode
 
bool _currentCharFlag
 
bool _boxSelect
 
int _scale
 
int _scaleH1
 
int _scaleH2
 
int _scaleN1
 
int _scaleT1
 
int _scaleMaxY
 
int _scaleI
 
int _scrollX
 
int _scrollY
 
int _scrollCol
 
int _scrollRow
 
bool _imgUnscaled
 
bool _canSaveLoad
 
Resource_establish
 
int _printEnd
 
int _txtPages
 
int _narateFile
 
int _sndSubFile
 
int _countTbl [6]
 
int _conversation
 
int _currentMan
 
uint32 _newTime
 
uint32 _newDate
 
int _flags [256]
 
int _travel [60]
 
int _ask [40]
 
int _startTravelItem
 
int _startTravelBox
 
int _startAboutItem
 
int _startAboutBox
 
int _boxDataStart
 
bool _boxDataEnd
 
int _boxSelectY
 
int _boxSelectYOld
 
int _numLines
 
byte _byte26CB5
 
int _bcnt
 
byte * _tempList
 
int _pictureTaken
 
bool _vidEnd
 
bool _clearSummaryFlag
 
bool _cheatFl
 
bool _restartFl
 
int & _useItem
 
int & _startup
 
int & _manScaleOff
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

void doRoom ()
 
void playVideo (int videoNum, const Common::Point &pt)
 
Common::Error run () override
 
bool hasFeature (EngineFeature f) const override
 
virtual void playGame ()=0
 
virtual void synchronize (Common::Serializer &s)
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
void defaultSyncSoundSettings ()
 
virtual void pauseEngineIntern (bool pause)
 

Protected Attributes

const AccessGameDescription_gameDescription
 
Common::RandomSource _randomSource
 
int _loadSaveSlot
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 

Member Function Documentation

◆ doRoom()

void Access::AccessEngine::doRoom ( )
protected

Main handler for showing game rooms

◆ playVideo()

void Access::AccessEngine::playVideo ( int  videoNum,
const Common::Point pt 
)
protected

Play back an entire video

◆ run()

Common::Error Access::AccessEngine::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Access::AccessEngine::hasFeature ( EngineFeature  f) const
overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ playGame()

virtual void Access::AccessEngine::playGame ( )
protectedpure virtual

◆ synchronize()

virtual void Access::AccessEngine::synchronize ( Common::Serializer s)
protectedvirtual

Synchronize savegame data

Reimplemented in Access::Amazon::AmazonEngine.

◆ freeCells()

void Access::AccessEngine::freeCells ( )

Free the sprites list

◆ printText()

void Access::AccessEngine::printText ( BaseSurface s,
const Common::String msg 
)

Draw a string on a given surface and update text positioning

◆ loadGameState()

Common::Error Access::AccessEngine::loadGameState ( int  slot)
overridevirtual

Load a savegame

Reimplemented from Engine.

◆ saveGameState()

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

Save the game

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Access::AccessEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Returns true if a savegame can currently be loaded

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Access::AccessEngine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Returns true if the game can currently be saved

Reimplemented from Engine.

◆ readSavegameHeader()

static WARN_UNUSED_RESULT bool Access::AccessEngine::readSavegameHeader ( Common::InSaveFile in,
AccessSavegameHeader header,
bool  skipThumbnail = true 
)
static

Read in a savegame header

◆ writeSavegameHeader()

void Access::AccessEngine::writeSavegameHeader ( Common::OutSaveFile out,
AccessSavegameHeader header 
)

Write out a savegame header


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