Tinsel::TinselEngine Class Reference

Inheritance diagram for Tinsel::TinselEngine:

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::SaveFileManager *	getSaveFileMan ()
Graphics::Surface &	screen ()
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
MetaEngine *	getMetaEngine () const
void	setMetaEngine (MetaEngine *metaEngine)
PauseToken	pauseEngine ()
bool	isPaused () const
void	openMainMenuDialog ()
uint32	getTotalPlayTime () const
void	setTotalPlayTime (uint32 time=0)
Common::TimerManager *	getTimerManager ()
Common::EventManager *	getEventManager ()
Common::SaveFileManager *	getSaveFileManager ()
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	errorString (const char *buf_input, char *buf_output, int buf_output_size)
virtual GUI::Debugger *	getDebugger () final
void	setDebugger (GUI::Debugger *debugger)
GUI::Debugger *	getOrCreateDebugger ()
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 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

gamePath

The 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

slot	The 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

msg	Optional 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:

• engines/tinsel/tinsel.h