ScummVM API documentation
Kingdom::KingdomGame Class Reference
Inheritance diagram for Kingdom::KingdomGame:
Engine

Public Member Functions

 KingdomGame (OSystem *syst, const ADGameDescription *gameDesc)
 
bool hasFeature (EngineFeature f) const override
 
Common::Error run () override
 
const char * getGameId () const
 
Common::Platform getPlatform () const
 
bool isDemo () const
 
void drawScreen ()
 
void setupPics ()
 
void initTools ()
 
void titlePage ()
 
void initPlay ()
 
void initHelp ()
 
void fadeToBlack1 ()
 
void fadeToBlack2 ()
 
Common::SeekableReadStreamloadAResource (int reznum)
 
void showPic (int reznum)
 
void fShowPic (int reznum)
 
void initCursor ()
 
void initMouse ()
 
void setMouse ()
 
void readMouse ()
 
void initMPlayer ()
 
void playMovie (int movieNum)
 
void saveAS ()
 
void restoreAS ()
 
void drawHelpScreen ()
 
void drawRect (uint minX, uint minY, uint maxX, uint maxY, int color)
 
void drawHotSpot (const HotSpot &hs, int color)
 
void drawInventory ()
 
void playSound (int idx)
 
void eraseCursor ()
 
void getUserInput ()
 
void eraseCursorAsm ()
 
void drawLocation ()
 
void processMap (int mapNum, int zoom)
 
void processMapInput (int mapNum)
 
void drawPic (int reznum)
 
void displayIcon (int reznum)
 
void setATimer ()
 
void refreshSound ()
 
void checkMainScreen ()
 
void switchAtoM ()
 
void switchMtoA ()
 
void drawIcon (int x, int y, int index)
 
int waitKey ()
 
void drawCursor ()
 
void cursorType ()
 
void loadKingArt ()
 
void unloadKingArt ()
 
void setCursor (int cursor)
 
int getAKey ()
 
int checkMouseMapAS ()
 
void cursorTypeExit ()
 
void saveGame ()
 
void restoreGame ()
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
Common::String getSavegameFilename (int slot)
 
void writeSavegameHeader (Common::OutSaveFile *out, KingdomSavegameHeader &header)
 
void synchronize (Common::Serializer &s)
 
void refreshScreen ()
 
void checkTimers ()
 
void initVariables ()
 
- 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 bool canLoadGameStateCurrently (Common::U32String *msg=nullptr)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
virtual bool canSaveGameStateCurrently (Common::U32String *msg=nullptr)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Static Public Member Functions

static bool readSavegameHeader (Common::InSaveFile *in, KingdomSavegameHeader &header)
 
- 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

const ADGameDescription_gameDescription
 
Common::RandomSource_rnd
 
bool _showHotspots
 
bool _loopFlag
 
int _gameMode
 
bool _fstFwd
 
bool _noIFScreen
 
bool _sound
 
bool _lastSound
 
bool _fullScreen
 
int _frameStop
 
int _daelonCntr
 
bool _itemInhibit
 
bool _asMode
 
bool _aTimerFlag
 
bool _bTimerFlag
 
bool _cTimerFlag
 
bool _skylarTimerFlag
 
int _aTimer
 
int _bTimer
 
int _cTimer
 
int _skylarTimer
 
bool _mapEx
 
int _healthTmr
 
int _treeEyeTimer
 
int _treeEyePic
 
int _treeEyeSta
 
int _treeHGTimer
 
int _treeHGPic
 
int _treeHGUPic
 
int _treeLeftPic
 
int _treeRightPic
 
int _treeRightSta
 
int _treeHGSta
 
bool _tsIconOnly
 
bool _noMusic
 
byte * _asPtr
 
int _asMap
 
int _oldTLS
 
int _oldTRS
 
int _treeLeftSta
 
bool _iconsClosed
 
bool _oldIconsClosed
 
int _pMovie
 
bool _demoMovieSkipped
 
bool _keyActive
 
bool _iconRedraw
 
bool _quit
 
bool _cursorDrawn
 
bool _wizard
 
int _zoom
 
int _mouseValue
 
int _cursorDef
 
int _oldCursorDef
 
Common::Point _cursorPos
 
Common::Point _oldCursorPos
 
int _iconSel
 
int _iconSelect
 
bool _mouseDebound
 
int _soundNumber
 
bool _palStepFlag
 
Audio::SoundHandle _soundHandle
 
int _tickCount
 
uint32 _oldTime
 
int _iconPic [7]
 
uint16 _userInput
 
uint16 _mouseButton
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Additional Inherited Members

- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 
- 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 Kingdom::KingdomGame::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ run()

Common::Error Kingdom::KingdomGame::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ loadGameState()

Common::Error Kingdom::KingdomGame::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 Kingdom::KingdomGame::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: