ScummVM
Adl::HiRes6Engine Class Reference
Inheritance diagram for Adl::HiRes6Engine:
Collaboration diagram for Adl::HiRes6Engine:

Public Member Functions

 HiRes6Engine (OSystem *syst, const AdlGameDescription *gd)
 
- Public Member Functions inherited from Adl::AdlEngine_v5
virtual ~AdlEngine_v5 ()
 
- Public Member Functions inherited from Adl::AdlEngine_v4
virtual ~AdlEngine_v4 ()
 
- Public Member Functions inherited from Adl::AdlEngine_v3
virtual ~AdlEngine_v3 ()
 
- Public Member Functions inherited from Adl::AdlEngine_v2
virtual ~AdlEngine_v2 ()
 
- Public Member Functions inherited from Adl::AdlEngine
virtual ~AdlEngine ()
 
bool pollEvent (Common::Event &event) const
 
void bell (uint count=1) const
 
- Public Member Functions inherited from Engine
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...
 
 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 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 initKeymap ()
 
virtual void deinitKeymap ()
 
virtual void flipMute ()
 Flip mute all sound option. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 

Private Member Functions

void gameLoop () override
 
void setupOpcodeTables () override
 
void runIntro () override
 
void init () override
 
void initGameState () override
 
void showRoom () override
 
int goDirection (ScriptEnv &e, Direction dir) override
 
Common::String formatVerbError (const Common::String &verb) const override
 
Common::String formatNounError (const Common::String &verb, const Common::String &noun) const override
 
void loadState (Common::ReadStream &stream) override
 
void saveState (Common::WriteStream &stream) override
 
void printString (const Common::String &str) override
 
bool canSaveGameStateCurrently () override
 Indicates whether a game state can be saved. More...
 
int o_fluteSound (ScriptEnv &e)
 

Private Attributes

byte _currVerb
 
byte _currNoun
 

Static Private Attributes

static const uint kRegions = 3
 
static const uint kItems = 15
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsRTL, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsJoystick
}
 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 bool warnUserAboutUnsupportedGame ()
 Display a warning to the user that the game is not fully supported. More...
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 
- Protected Types inherited from Adl::AdlEngine_v4
enum  RegionChunkType {
  kRegionChunkUnknown, kRegionChunkMessages, kRegionChunkGlobalPics, kRegionChunkVerbs,
  kRegionChunkNouns, kRegionChunkRooms, kRegionChunkRoomCmds, kRegionChunkGlobalCmds
}
 
- Protected Types inherited from Adl::AdlEngine
typedef Common::SharedPtr< Common::Functor1< ScriptEnv &, int > > Opcode
 
- Protected Member Functions inherited from Adl::AdlEngine_v5
 AdlEngine_v5 (OSystem *syst, const AdlGameDescription *gd)
 
RegionChunkType getRegionChunkType (const uint16 addr) const override
 
void initRoomState (RoomState &roomState) const override
 
byte restoreRoomState (byte room) override
 
int o_isNounNotInRoom (ScriptEnv &e) override
 
virtual int o_abortScript (ScriptEnv &e)
 
virtual int o_dummy (ScriptEnv &e)
 
virtual int o_setTextMode (ScriptEnv &e)
 
int o_setRegionRoom (ScriptEnv &e) override
 
int o_setRoomPic (ScriptEnv &e) override
 
- Protected Member Functions inherited from Adl::AdlEngine_v4
 AdlEngine_v4 (OSystem *syst, const AdlGameDescription *gd)
 
Common::String loadMessage (uint idx) const override
 
Common::String getItemDescription (const Item &item) const override
 
void switchRegion (byte region) override
 
void switchRoom (byte roomNr) override
 
void adjustDataBlockPtr (byte &track, byte &sector, byte &offset, byte &size) const override
 
void loadRegionLocations (Common::ReadStream &stream, uint regions)
 
void loadRegionInitDataOffsets (Common::ReadStream &stream, uint regions)
 
void initRegions (const byte *roomsPerRegion, uint regions)
 
void fixupDiskOffset (byte &track, byte &sector) const
 
void loadRegion (byte region)
 
void loadItemPicIndex (Common::ReadStream &stream, uint items)
 
void backupRoomState (byte room)
 
void backupVars ()
 
void restoreVars ()
 
int o_isItemInRoom (ScriptEnv &e) override
 
virtual int o_isVarGT (ScriptEnv &e)
 
int o_moveItem (ScriptEnv &e) override
 
virtual int o_setRegionToPrev (ScriptEnv &e)
 
int o_moveAllItems (ScriptEnv &e) override
 
virtual int o_setRegion (ScriptEnv &e)
 
int o_save (ScriptEnv &e) override
 
int o_restore (ScriptEnv &e) override
 
int o_restart (ScriptEnv &e) override
 
- Protected Member Functions inherited from Adl::AdlEngine_v3
 AdlEngine_v3 (OSystem *syst, const AdlGameDescription *gd)
 
void loadItemDescriptions (Common::SeekableReadStream &stream, byte count)
 
- Protected Member Functions inherited from Adl::AdlEngine_v2
 AdlEngine_v2 (OSystem *syst, const AdlGameDescription *gd)
 
void initState () override
 
byte roomArg (byte room) const override
 
void advanceClock () override
 
void drawItems () override
 
void drawItem (Item &item, const Common::Point &pos) override
 
void loadRoom (byte roomNr) override
 
void takeItem (byte noun) override
 
void insertDisk (byte volume)
 
virtual DataBlockPtr readDataBlockPtr (Common::ReadStream &f) const
 
void loadItems (Common::ReadStream &stream)
 
void loadRooms (Common::ReadStream &stream, byte count)
 
void loadMessages (Common::ReadStream &stream, byte count)
 
void loadPictures (Common::ReadStream &stream)
 
void loadItemPictures (Common::ReadStream &stream, byte count)
 
virtual bool isInventoryFull ()
 
int askForSlot (const Common::String &question)
 
void checkTextOverflow (char c)
 
void handleTextOverflow ()
 
virtual int o_isFirstTime (ScriptEnv &e)
 
virtual int o_isRandomGT (ScriptEnv &e)
 
virtual int o_isCarryingSomething (ScriptEnv &e)
 
int o_setCurPic (ScriptEnv &e) override
 
int o_setPic (ScriptEnv &e) override
 
int o_placeItem (ScriptEnv &e) override
 
virtual int o_tellTime (ScriptEnv &e)
 
virtual int o_setRoomFromVar (ScriptEnv &e)
 
virtual int o_initDisk (ScriptEnv &e)
 
- Protected Member Functions inherited from Adl::AdlEngine
 AdlEngine (OSystem *syst, const AdlGameDescription *gd)
 
Common::Error loadGameState (int slot)
 Load a game state. More...
 
Common::Error saveGameState (int slot, const Common::String &desc)
 Save a game state. More...
 
Common::String getDiskImageName (byte volume) const
 
GameType getGameType () const
 
GameVersion getGameVersion () const
 
Common::String readString (Common::ReadStream &stream, byte until=0) const
 
Common::String readStringAt (Common::SeekableReadStream &stream, uint offset, byte until=0) const
 
void openFile (Common::File &file, const Common::String &name) const
 
virtual void printMessage (uint idx)
 
void delay (uint32 ms) const
 
virtual Common::String getLine ()
 
Common::String inputString (byte prompt=0) const
 
byte inputKey (bool showCursor=true) const
 
void getInput (uint &verb, uint &noun)
 
void loadWords (Common::ReadStream &stream, WordMap &map, Common::StringArray &pri) const
 
void readCommands (Common::ReadStream &stream, Commands &commands)
 
void removeCommand (Commands &commands, uint idx)
 
CommandgetCommand (Commands &commands, uint idx)
 
void checkInput (byte verb, byte noun)
 
virtual bool isInputValid (byte verb, byte noun, bool &is_any)
 
virtual bool isInputValid (const Commands &commands, byte verb, byte noun, bool &is_any)
 
virtual void applyRoomWorkarounds (byte roomNr)
 
virtual void applyRegionWorkarounds ()
 
void loadDroppedItemOffsets (Common::ReadStream &stream, byte count)
 
template<class T >
Opcode opcode (int(T::*f)(ScriptEnv &))
 
virtual int o_isMovesGT (ScriptEnv &e)
 
virtual int o_isVarEQ (ScriptEnv &e)
 
virtual int o_isCurPicEQ (ScriptEnv &e)
 
virtual int o_isItemPicEQ (ScriptEnv &e)
 
virtual int o_varAdd (ScriptEnv &e)
 
virtual int o_varSub (ScriptEnv &e)
 
virtual int o_varSet (ScriptEnv &e)
 
virtual int o_listInv (ScriptEnv &e)
 
virtual int o_setRoom (ScriptEnv &e)
 
virtual int o_printMsg (ScriptEnv &e)
 
virtual int o_setLight (ScriptEnv &e)
 
virtual int o_setDark (ScriptEnv &e)
 
virtual int o_quit (ScriptEnv &e)
 
virtual int o_setItemPic (ScriptEnv &e)
 
virtual int o_resetPic (ScriptEnv &e)
 
virtual int o_takeItem (ScriptEnv &e)
 
virtual int o_dropItem (ScriptEnv &e)
 
int o_goNorth (ScriptEnv &e)
 
int o_goSouth (ScriptEnv &e)
 
int o_goEast (ScriptEnv &e)
 
int o_goWest (ScriptEnv &e)
 
int o_goUp (ScriptEnv &e)
 
int o_goDown (ScriptEnv &e)
 
void drawPic (byte pic, Common::Point pos=Common::Point()) const
 
bool playTones (const Tones &tones, bool isMusic, bool allowSkip=false) const
 
const RegiongetRegion (uint i) const
 
RegiongetRegion (uint i)
 
const RoomgetRoom (uint i) const
 
RoomgetRoom (uint i)
 
const RegiongetCurRegion () const
 
RegiongetCurRegion ()
 
const RoomgetCurRoom () const
 
RoomgetCurRoom ()
 
const ItemgetItem (uint i) const
 
ItemgetItem (uint i)
 
byte getVar (uint i) const
 
void setVar (uint i, byte value)
 
virtual void dropItem (byte noun)
 
bool matchCommand (ScriptEnv &env) const
 
void doActions (ScriptEnv &env)
 
bool doOneCommand (const Commands &commands, byte verb, byte noun)
 
void doAllCommands (const Commands &commands, byte verb, byte noun)
 
virtual ScriptEnvcreateScriptEnv (const Command &cmd, byte room, byte verb, byte noun)
 
Common::String itemStr (uint i) const
 
Common::String roomStr (uint i) const
 
Common::String itemRoomStr (uint i) const
 
Common::String verbStr (uint i) const
 
Common::String nounStr (uint i) const
 
Common::String msgStr (uint i) const
 
Common::String dirStr (Direction dir) const
 
bool op_debug (const char *fmt,...) const
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
bool shouldPerformAutoSave (int lastSaveTime)
 Indicate whether an autosave should be performed. More...
 
virtual void pauseEngineIntern (bool pause)
 Actual implementation of pauseEngine by subclasses. More...
 
- Static Protected Member Functions inherited from Adl::AdlEngine
static Common::String toAscii (const Common::String &str)
 
- Protected Attributes inherited from Adl::AdlEngine_v4
Common::Array< RegionLocation_regionLocations
 
Common::Array< RegionInitDataOffset_regionInitDataOffsets
 
Common::SeekableReadStream_itemPicIndex
 
- Protected Attributes inherited from Adl::AdlEngine_v3
Common::Array< Common::String_itemDesc
 
- Protected Attributes inherited from Adl::AdlEngine_v2
struct {
   Common::String   time
 
   Common::String   saveInsert
 
   Common::String   saveReplace
 
   Common::String   restoreInsert
 
   Common::String   restoreReplace
 
_strings_v2
 
uint _maxLines
 
DiskImage_disk
 
byte _currentVolume
 
Common::Array< DataBlockPtr_itemPics
 
bool _itemRemoved
 
byte _roomOnScreen
 
byte _picOnScreen
 
byte _itemsOnScreen
 
Common::Array< byte_brokenRooms
 
- Protected Attributes inherited from Adl::AdlEngine
Common::DumpFile_dumpFile
 
Display_display
 
GraphicsMan_graphics
 
bool _textMode
 
Common::Array< Opcode_condOpcodes
 
Common::Array< Opcode_actOpcodes
 
Common::Array< DataBlockPtr_messages
 
PictureMap _pictures
 
Common::Array< Common::Point_itemOffsets
 
Commands _roomCommands
 
Commands _globalCommands
 
RoomData _roomData
 
WordMap _verbs
 
WordMap _nouns
 
Common::StringArray _priVerbs
 
Common::StringArray _priNouns
 
struct {
   Common::String   enterCommand
 
   Common::String   verbError
 
   Common::String   nounError
 
   Common::String   playAgain
 
   Common::String   pressReturn
 
   Common::String   lineFeeds
 
_strings
 
struct {
   uint   cantGoThere
 
   uint   dontUnderstand
 
   uint   itemDoesntMove
 
   uint   itemNotHere
 
   uint   thanksForPlaying
 
_messageIds
 
State _state
 
uint _linesPrinted
 
bool _isRestarting
 
bool _isRestoring
 
bool _isQuitting
 
bool _canSaveNow
 
bool _canRestoreNow
 
bool _abortScript
 
Common::RandomSource_random
 
const AdlGameDescription_gameDescription
 
Common::File_inputScript
 
uint _scriptDelay
 
bool _scriptPaused
 
- 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 37 of file hires6.cpp.

Constructor & Destructor Documentation

◆ HiRes6Engine()

Adl::HiRes6Engine::HiRes6Engine ( OSystem syst,
const AdlGameDescription gd 
)
inline

Definition at line 39 of file hires6.cpp.

Member Function Documentation

◆ canSaveGameStateCurrently()

bool Adl::HiRes6Engine::canSaveGameStateCurrently ( )
overrideprivatevirtual

Indicates whether a game state can be saved.

Reimplemented from Adl::AdlEngine_v2.

Definition at line 143 of file hires6.cpp.

◆ formatNounError()

Common::String Adl::HiRes6Engine::formatNounError ( const Common::String verb,
const Common::String noun 
) const
overrideprivatevirtual

Reimplemented from Adl::AdlEngine.

Definition at line 355 of file hires6.cpp.

◆ formatVerbError()

Common::String Adl::HiRes6Engine::formatVerbError ( const Common::String verb) const
overrideprivatevirtual

Reimplemented from Adl::AdlEngine.

Definition at line 336 of file hires6.cpp.

◆ gameLoop()

void Adl::HiRes6Engine::gameLoop ( )
overrideprivatevirtual

Reimplemented from Adl::AdlEngine_v4.

Definition at line 73 of file hires6.cpp.

◆ goDirection()

int Adl::HiRes6Engine::goDirection ( ScriptEnv e,
Direction  dir 
)
overrideprivatevirtual

Reimplemented from Adl::AdlEngine.

Definition at line 102 of file hires6.cpp.

◆ init()

void Adl::HiRes6Engine::init ( void  )
overrideprivatevirtual

Implements Adl::AdlEngine.

Definition at line 231 of file hires6.cpp.

◆ initGameState()

void Adl::HiRes6Engine::initGameState ( )
overrideprivatevirtual

Implements Adl::AdlEngine.

Definition at line 272 of file hires6.cpp.

◆ loadState()

void Adl::HiRes6Engine::loadState ( Common::ReadStream stream)
overrideprivatevirtual

Reimplemented from Adl::AdlEngine_v4.

Definition at line 377 of file hires6.cpp.

◆ o_fluteSound()

int Adl::HiRes6Engine::o_fluteSound ( ScriptEnv e)
private

Definition at line 127 of file hires6.cpp.

◆ printString()

void Adl::HiRes6Engine::printString ( const Common::String str)
overrideprivatevirtual

Reimplemented from Adl::AdlEngine_v2.

Definition at line 391 of file hires6.cpp.

◆ runIntro()

void Adl::HiRes6Engine::runIntro ( )
overrideprivatevirtual

Reimplemented from Adl::AdlEngine.

Definition at line 194 of file hires6.cpp.

◆ saveState()

void Adl::HiRes6Engine::saveState ( Common::WriteStream stream)
overrideprivatevirtual

Reimplemented from Adl::AdlEngine_v4.

Definition at line 383 of file hires6.cpp.

◆ setupOpcodeTables()

void Adl::HiRes6Engine::setupOpcodeTables ( )
overrideprivatevirtual

Reimplemented from Adl::AdlEngine_v5.

Definition at line 96 of file hires6.cpp.

◆ showRoom()

void Adl::HiRes6Engine::showRoom ( )
overrideprivatevirtual

Reimplemented from Adl::AdlEngine_v2.

Definition at line 290 of file hires6.cpp.

Member Data Documentation

◆ _currNoun

byte Adl::HiRes6Engine::_currNoun
private

Definition at line 70 of file hires6.cpp.

◆ _currVerb

byte Adl::HiRes6Engine::_currVerb
private

Definition at line 70 of file hires6.cpp.

◆ kItems

const uint Adl::HiRes6Engine::kItems = 15
staticprivate

Definition at line 68 of file hires6.cpp.

◆ kRegions

const uint Adl::HiRes6Engine::kRegions = 3
staticprivate

Definition at line 67 of file hires6.cpp.


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