ScummVM API documentation
Tinsel::TinselEngine Class Reference
Inheritance diagram for Tinsel::TinselEngine:
Engine

Public Member Functions

 TinselEngine (OSystem *syst, const TinselGameDescription *gameDesc)
 
int getGameId ()
 
uint32 getGameID () const
 
uint32 getFeatures () const
 
Common::Language getLanguage () const
 
uint16 getVersion () const
 
Common::Platform getPlatform () const
 
bool getIsADGFDemo () const
 
bool isV1CD () const
 
const char * getSampleIndex (LANGUAGE lang)
 
const char * getSampleFile (LANGUAGE lang)
 
const char * getTextFile (LANGUAGE lang)
 
const char * getSceneFile (LANGUAGE lang)
 
const Common::String getTargetName () const
 
Common::String getSavegameFilename (int16 saveNum) const
 
Common::SaveFileManagergetSaveFileMan ()
 
Graphics::Surfacescreen ()
 
Common::Point getMousePosition () const
 
void setMousePosition (Common::Point pt)
 
void divertKeyInput (KEYFPTR fptr)
 
int getRandomNumber (int maxNumber)
 
uint8 getKeyDirection () const
 
- 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
 
virtual bool gameTypeHasAddOns () const
 
virtual bool dirCanBeGameAddOn (const Common::FSDirectory &dir) const
 
virtual bool dirMustBeGameAddOn (const Common::FSDirectory &dir) const
 
Common::ErrorCode updateAddOns (const MetaEngine *metaEngine) const
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
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 saveGameState (int slot, const Common::String &desc, bool isAutosave=false)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
virtual bool canSaveGameStateCurrently (Common::U32String *msg=nullptr)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

const TinselGameDescription_gameDescription
 
MidiDriver_driver
 
SoundManager_sound
 
MidiMusicPlayer_midiMusic
 
PCMMusicPlayer_pcmMusic
 
Music_music
 
BMVPlayer_bmv
 
Background_bg
 
Font_font
 
Cursor_cursor
 
Actor_actor
 
Handle_handle
 
Config_config
 
Scroll_scroll
 
Dialogs_dialogs
 
Notebook_notebook = nullptr
 
SystemReel_systemReel = nullptr
 
Spriter_spriter = nullptr
 
KEYFPTR _keyHandler
 
Common::List< Common::EventType_mouseButtons
 
Common::List< Common::Event_keypresses
 
RectList _clipRects
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

void initializePath (const Common::FSNode &gamePath) override
 
Common::Error run () override
 
bool hasFeature (EngineFeature f) const override
 
Common::Error loadGameState (int slot) override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) 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 bool warnUserAboutUnsupportedAddOn (Common::String addOnName)
 
static void errorAddingAddOnWithoutBaseGame (Common::String addOnName, Common::String gameId)
 
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

◆ initializePath()

void Tinsel::TinselEngine::initializePath ( const Common::FSNode gamePath)
overrideprotectedvirtual

Initialize SearchMan according to the game path.

By default, this adds the directory in non-flat mode with a depth of 4 as priority 0 to SearchMan.

Parameters
gamePathThe base directory of the game data.

Reimplemented from Engine.

◆ run()

Common::Error Tinsel::TinselEngine::run ( )
overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ hasFeature()

bool Tinsel::TinselEngine::hasFeature ( EngineFeature  f) const
overrideprotectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ loadGameState()

Common::Error Tinsel::TinselEngine::loadGameState ( int  slot)
overrideprotectedvirtual

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.

◆ canLoadGameStateCurrently()

bool Tinsel::TinselEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overrideprotectedvirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

Member Data Documentation

◆ _mouseButtons

Common::List<Common::EventType> Tinsel::TinselEngine::_mouseButtons

Stack of pending mouse button events.

◆ _keypresses

Common::List<Common::Event> Tinsel::TinselEngine::_keypresses

Stack of pending keypresses.

◆ _clipRects

RectList Tinsel::TinselEngine::_clipRects

List of all clip rectangles.


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