ScummVM API documentation
Avalanche::AvalancheEngine Class Reference
Inheritance diagram for Avalanche::AvalancheEngine:
Engine

Public Member Functions

 AvalancheEngine (OSystem *syst, const AvalancheGameDescription *gd)
 
Common::ErrorCode initialize ()
 
uint32 getFeatures () const
 
const char * getGameId () const
 
Common::Platform getPlatform () const
 
bool hasFeature (EngineFeature f) const override
 
const char * getCopyrightString () const
 
void synchronize (Common::Serializer &sz)
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
bool saveGame (const int16 slot, const Common::String &desc)
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error loadGameState (int slot) override
 
bool loadGame (const int16 slot)
 
Common::String expandDate (int d, int m, int y)
 
uint32 getTimeInSeconds ()
 
void updateEvents ()
 
bool getEvent (Common::Event &event)
 
Common::Point getMousePos ()
 
void callVerb (VerbCode id)
 
void loadBackground (byte num)
 
void loadRoom (byte num)
 
void thinkAbout (byte object, bool type)
 
void incScore (byte num)
 
void fxToggle ()
 
void refreshObjectList ()
 
void errorLed ()
 
void fadeOut ()
 
void fadeIn ()
 
void drawDirection ()
 
void gameOver ()
 
uint16 bearing (byte whichPed)
 
void minorRedraw ()
 
void spriteRun ()
 
Common::String intToStr (int32 num)
 
void newGame ()
 
bool getFlag (char x)
 
bool decreaseMoney (uint16 amount)
 
Common::String getName (People whose)
 
Common::String getItem (byte which)
 
Common::String f5Does ()
 
void openDoor (Room whither, byte ped, byte magicnum)
 
void flipRoom (Room room, byte ped)
 
void setRoom (People persId, Room roomId)
 
Room getRoom (People persId)
 
- 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 ()
 

Public Attributes

byte _saveNum
 
Clock_clock
 
GraphicManager_graphics
 
Parser_parser
 
Dialogs_dialogs
 
Background_background
 
Sequence_sequence
 
Timer_timer
 
Animation_animation
 
DropDownMenu_dropdown
 
Closing_closing
 
SoundHandler_sound
 
Nim_nim
 
GhostRoom_ghostroom
 
Help_help
 
HighScore_highscore
 
Common::RandomSource_rnd
 
const AvalancheGameDescription_gameDescription
 
bool _holdLeftMouse
 
byte _interrogation
 
byte _carryNum
 
bool _objects [kObjectNum]
 
int16 _score
 
int32 _money
 
Room _room
 
bool _wonNim
 
byte _wineState
 
bool _cwytalotGone
 
byte _passwordNum
 
bool _aylesIsAwake
 
byte _drawbridgeOpen
 
byte _avariciusTalk
 
bool _rottenOnion
 
bool _onionInVinegar
 
byte _givenToSpludwick
 
byte _brummieStairs
 
byte _cardiffQuestionNum
 
bool _avvyIsAwake
 
bool _avvyInBed
 
bool _userMovesAvvy
 
byte _npcFacing
 
bool _givenBadgeToIby
 
bool _friarWillTieYouUp
 
bool _tiedUp
 
byte _boxContent
 
bool _talkedToCrapulus
 
byte _jacquesState
 
bool _bellsAreRinging
 
bool _standingOnDais
 
bool _takenPen
 
bool _arrowInTheDoor
 
Common::String _favoriteDrink
 
Common::String _favoriteSong
 
Common::String _worstPlaceOnEarth
 
Common::String _spareEvening
 
uint32 _startTime
 
uint32 _totalTime
 
byte _jumpStatus
 
bool _mushroomGrowing
 
bool _crapulusWillTell
 
bool _enterCatacombsFromLustiesRoom
 
bool _teetotal
 
byte _malagauche
 
char _drinking
 
bool _enteredLustiesRoomAsMonk
 
byte _catacombX
 
byte _catacombY
 
bool _avvysInTheCupboard
 
bool _geidaFollows
 
bool _givenPotionToGeida
 
bool _lustieIsAsleep
 
bool _beenTiedUp
 
bool _sittingInPub
 
byte _spurgeTalkCount
 
bool _metAvaroid
 
bool _takenMushroom
 
bool _givenPenToAyles
 
bool _askedDogfoodAboutNim
 
bool _showDebugLines
 
byte _lineNum
 
LineType _lines [50]
 
bool _dropsOk
 
bool _cheat
 
bool _letMeOut
 
byte _thinks
 
bool _thinkThing
 
bool _animationsEnabled
 
char _objectList [10]
 
byte _currentMouse
 
Common::String_also [31][2]
 
PedType _peds [15]
 
MagicType _magics [15]
 
MagicType _portals [7]
 
FieldType _fields [30]
 
byte _fieldNum
 
Common::String _listen
 
byte _cp
 
byte _ledStatus
 
FontType _font
 
bool _alive
 
byte _subjectNum
 
People _him
 
People _her
 
byte _it
 
uint32 _roomCycles
 
bool _doingSpriteRun
 
bool _soundFx
 
bool _isLoaded
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Static Public Attributes

static const bool kThing = true
 
static const bool kPerson = false
 
static const char kSpludwicksOrder [3]
 
static const uint16 kNotes [12]
 

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 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 Avalanche::AvalancheEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Avalanche::AvalancheEngine::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.

◆ saveGameState()

Common::Error Avalanche::AvalancheEngine::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.

◆ canLoadGameStateCurrently()

bool Avalanche::AvalancheEngine::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.

◆ loadGameState()

Common::Error Avalanche::AvalancheEngine::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.

◆ run()

Common::Error Avalanche::AvalancheEngine::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: