ScummVM API documentation
Illusions::IllusionsEngine Class Referenceabstract
Inheritance diagram for Illusions::IllusionsEngine:
Engine Illusions::IllusionsEngine_BBDOU Illusions::IllusionsEngine_Duckman

Classes

struct  SaveHeader
 

Public Types

enum  kReadSaveHeaderError { kRSHENoError = 0, kRSHEInvalidType = 1, kRSHEInvalidVersion = 2, kRSHEIoError = 3 }
 
- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 

Public Member Functions

 IllusionsEngine (OSystem *syst, const IllusionsGameDescription *gd)
 
const Common::String getTargetName ()
 
void updateEvents ()
 
int getGameId () const
 
Common::Language getGameLanguage () const
 
void runUpdateFunctions ()
 
int updateActors (uint flags)
 
int updateSequences (uint flags)
 
int updateGraphics (uint flags)
 
int updateSoundMan (uint flags)
 
int updateSprites (uint flags)
 
uint32 getElapsedUpdateTime ()
 
Common::PointgetObjectActorPositionPtr (uint32 objectId)
 
int getRandom (int max)
 
int convertPanXCoord (int16 x)
 
bool calcPointDirection (Common::Point &srcPt, Common::Point &dstPt, uint &facing)
 
bool isSoundActive ()
 
virtual void updateFader ()
 
virtual void clearFader ()
 
virtual void pauseFader ()
 
virtual void unpauseFader ()
 
virtual bool isVideoPlaying ()
 
void setCurrFontId (uint32 fontId)
 
bool checkActiveTalkThreads ()
 
void setTextDuration (int kind, uint32 duration)
 
uint32 clipTextDuration (uint32 duration)
 
void getDefaultTextDimensions (WidthHeight &dimensions)
 
void setDefaultTextDimensions (WidthHeight &dimensions)
 
void getDefaultTextPosition (Common::Point &position)
 
void setDefaultTextPosition (Common::Point &position)
 
uint16 getSubtitleDuration ()
 
void setSubtitleDuration (uint16 duration)
 
FramesListfindActorSequenceFrames (Sequence *sequence)
 
virtual void setDefaultTextCoords ()=0
 
virtual void loadSpecialCode (uint32 resId)=0
 
virtual void unloadSpecialCode (uint32 resId)=0
 
virtual void notifyThreadId (uint32 &threadId)=0
 
virtual bool testMainActorFastWalk (Control *control)=0
 
virtual bool testMainActorCollision (Control *control)=0
 
virtual ControlgetObjectControl (uint32 objectId)=0
 
virtual Common::Point getNamedPointPosition (uint32 namedPointId)=0
 
virtual uint32 getPriorityFromBase (int16 priority)=0
 
virtual uint32 getPrevScene ()=0
 
virtual uint32 getCurrentScene ()=0
 
virtual bool isCursorObject (uint32 actorTypeId, uint32 objectId)=0
 
virtual void setCursorControlRoutine (Control *control)=0
 
virtual void placeCursorControl (Control *control, uint32 sequenceId)=0
 
virtual void setCursorControl (Control *control)=0
 
virtual void showCursor ()=0
 
virtual void hideCursor ()=0
 
virtual void startScriptThreadSimple (uint32 threadId, uint32 callingThreadId)=0
 
virtual uint32 startTempScriptThread (byte *scriptCodeIp, uint32 callingThreadId, uint32 value8, uint32 valueC, uint32 value10)=0
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
Common::Error removeGameState (int slot)
 
bool savegame (const char *filename, const char *description)
 
bool loadgame (const char *filename)
 
bool existsSavegame (int num)
 
- 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 Common::Error run ()=0
 
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 bool hasFeature (EngineFeature f) const
 
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 Common::String getSavegameFilename (const Common::String &target, int num)
 
static kReadSaveHeaderError readSaveHeader (Common::SeekableReadStream *in, SaveHeader &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

Common::RandomSource_random
 
Dictionary_dict
 
ResourceSystem_resSys
 
BaseResourceReader_resReader
 
UpdateFunctions_updateFunctions
 
GameState_gameState
 
Screen_screen
 
ScreenPaletteBase_screenPalette
 
ScreenText_screenText
 
Input_input
 
ActorInstanceList_actorInstances
 
BackgroundInstanceList_backgroundInstances
 
Camera_camera
 
Controls_controls
 
TalkInstanceList_talkItems
 
ScriptOpcodes_scriptOpcodes
 
SpecialCode_specialCode
 
ThreadList_threads
 
SoundMan_soundMan
 
uint32 _nextTempThreadId
 
bool _doScriptThreadInit
 
ScriptStack_stack
 
ScriptResource_scriptResource
 
bool _rerunThreads
 
Fader_fader
 
int _pauseCtr
 
int _resGetCtr
 
uint32 _resGetTime
 
bool _unpauseControlActorFlag
 
uint32 _lastUpdateTime
 
int _resumeFromSavegameRequested
 
int _savegameSlotNum
 
Common::String _savegameDescription
 
uint32 _savegameSceneId
 
uint32 _savegameThreadId
 
uint32 _fontId
 
int _field8
 
uint32 _fieldA
 
uint32 _subtitleDuration
 
WidthHeight _defaultTextDimensions
 
Common::Point _defaultTextPosition
 
int16 _menuChoiceOfs
 
bool _isSaveAllowed
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Additional Inherited Members

- 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
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Member Function Documentation

◆ canLoadGameStateCurrently()

bool Illusions::IllusionsEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Illusions::IllusionsEngine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
inlineoverridevirtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ loadGameState()

Common::Error Illusions::IllusionsEngine::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 Illusions::IllusionsEngine::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: