Inheritance diagram for Twp::TwpEngine:

Classes
struct	Cursor

struct	Stats

Public Member Functions
	TwpEngine (OSystem syst, const TwpGameDescription gameDesc)

uint32	getFeatures () const

Common::String	getGameId () const

Common::RandomSource &	getRandomSource ()

HSQUIRRELVM	getVm ()

Gfx &	getGfx ()

TextDb &	getTextDb ()

bool	hasFeature (EngineFeature f) const override

void	updateSettingVars ()

bool	canLoadGameStateCurrently (Common::U32String *msg=nullptr) override

bool	canSaveGameStateCurrently (Common::U32String *msg=nullptr) override

Common::Error	saveGameStream (Common::WriteStream *stream, bool isAutosave=false) override

Common::Error	loadGameState (int slot) override

Common::Error	loadGameStream (Common::SeekableReadStream *stream) override

Common::Error	saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override

bool	canSaveAutosaveCurrently () override

void	capture (Graphics::Surface &surface, int width, int height)

Math::Vector2d	winToScreen (const Math::Vector2d &pos) const

Math::Vector2d	screenToWin (const Math::Vector2d &pos) const

Math::Vector2d	roomToScreen (const Math::Vector2d &pos) const

Math::Vector2d	screenToRoom (const Math::Vector2d &pos) const

void	setActor (Common::SharedPtr< Object > actor, bool userSelected=false)

Common::SharedPtr< Object >	objAt (const Math::Vector2d &pos)

void	flashSelectableActor (int flash)

void	sayLineAt (const Math::Vector2d &pos, const Color &color, Common::SharedPtr< Object > actor, float duration, const Common::String &text)

void	stopTalking ()

bool	isSomeoneTalking () const

void	walkFast (bool state=true)

void	actorEnter (Common::SharedPtr< Object > actor)

void	actorExit (Common::SharedPtr< Object > actor)

Common::SharedPtr< Room >	defineRoom (const Common::String &name, HSQOBJECT table, bool pseudo=false)

void	setRoom (Common::SharedPtr< Room > room, bool force=false)

void	enterRoom (Common::SharedPtr< Room > room, Common::SharedPtr< Object > door=nullptr)

void	cameraAt (const Math::Vector2d &at)

Math::Vector2d	cameraPos ()

void	follow (Common::SharedPtr< Object > actor)

void	fadeTo (FadeEffect effect, float duration, bool fadeToSep=false)

void	execNutEntry (HSQUIRRELVM v, const Common::String &entry)

void	execBnutEntry (HSQUIRRELVM v, const Common::String &entry)

bool	callVerb (Common::SharedPtr< Object > actor, VerbId verbId, Common::SharedPtr< Object > noun1, Common::SharedPtr< Object > noun2=nullptr)

bool	execSentence (Common::SharedPtr< Object > actor, VerbId verbId, Common::SharedPtr< Object > noun1, Common::SharedPtr< Object > noun2=nullptr)

float	getRandom () const

float	getRandom (float min, float max) const

int	runDialog (GUI::Dialog &dialog) override

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 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	initializePath (const Common::FSNode &gamePath)

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

void	setGameToLoadSlot (int slot)

bool	saveGameDialog ()

bool	loadGameDialog ()

Public Attributes
unique_ptr< GGPackSet >	_pack

unique_ptr< ResManager >	_resManager

Common::Array< Common::SharedPtr< Room > >	_rooms

Common::Array< Common::SharedPtr< Object > >	_actors

Common::Array< Common::SharedPtr< ThreadBase > >	_threads

Common::Array< Common::SharedPtr< Task > >	_tasks

Common::Array< Common::SharedPtr< Callback > >	_callbacks

Common::SharedPtr< Object >	_actor

Common::SharedPtr< Object >	_followActor

Common::SharedPtr< Room >	_room

float	_time = 0.f

Common::SharedPtr< Object >	_noun1

Common::SharedPtr< Object >	_noun2

UseFlag	_useFlag

HSQOBJECT	_defaultObj

bool	_walkFastState = false

bool	_holdToMove = false

float	_nextHoldToMoveTime = 0.f

int	_frameCounter = 0

Common::SharedPtr< Lighting >	_lighting

Common::SharedPtr< Cutscene >	_cutscene

unique_ptr< Scene >	_scene

unique_ptr< Scene >	_screenScene

unique_ptr< NoOverrideNode >	_noOverride

InputState	_inputState

unique_ptr< Camera >	_camera

unique_ptr< TextDb >	_textDb

unique_ptr< Dialog >	_dialog

struct Twp::TwpEngine::Cursor	_cursor

struct Twp::TwpEngine::Stats	_stats

unique_ptr< Hud >	_hud

Inventory	_uiInv

ActorSwitcher	_actorSwitcher

unique_ptr< AudioSystem >	_audio

unique_ptr< SaveGameManager >	_saveGameManager

unique_ptr< ShaderParams >	_shaderParams

unique_ptr< HotspotMarkerNode >	_hotspotMarker

unique_ptr< FadeShader >	_fadeShader

unique_ptr< LightingNode >	_lightingNode

unique_ptr< Motor >	_moveCursorTo

Public Attributes inherited from Engine
OSystem *	_system

Audio::Mixer *	_mixer

Protected Member Functions
Common::Error	run () override

Protected Member Functions inherited from Engine
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

◆ run()

Common::Error Twp::TwpEngine::run ( )

overrideprotectedvirtual

Initialize the engine and start its main loop.

Returns: kNoError on success, otherwise an error code.

Implements Engine.

◆ getGameId()

Common::String Twp::TwpEngine::getGameId ( ) const

Returns the game Id

◆ getRandomSource()

Common::RandomSource& Twp::TwpEngine::getRandomSource ( )

inline

Gets the random source

◆ hasFeature()

bool Twp::TwpEngine::hasFeature ( EngineFeature f ) const

inlineoverridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Twp::TwpEngine::canLoadGameStateCurrently ( Common::U32String * msg = nullptr )

inlineoverridevirtual

Indicate whether a game state can be loaded.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Twp::TwpEngine::canSaveGameStateCurrently ( Common::U32String * msg = nullptr )

overridevirtual

Indicate whether a game state can be saved.

Parameters

msg	Optional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ saveGameStream()

Common::Error Twp::TwpEngine::saveGameStream	(	Common::WriteStream *	stream,
		bool	isAutosave = `false`
	)

overridevirtual

Save a game state.

Parameters

stream	The write stream to save the savegame data to.
isAutosave	Expected to be true if an autosave is being created.

Returns: kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ loadGameState()

Common::Error Twp::TwpEngine::loadGameState ( int slot )

overridevirtual

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.

◆ loadGameStream()

Common::Error Twp::TwpEngine::loadGameStream ( Common::SeekableReadStream * stream )

overridevirtual

Load a game state.

Parameters

stream The stream to load the save state from.

Returns: kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ saveGameState()

Common::Error Twp::TwpEngine::saveGameState	(	int	slot,
		const Common::String &	desc,
		bool	isAutosave = `false`
	)

overridevirtual

Save a game state.

Parameters

slot	The slot into which the save state should be stored.
desc	Description for the save state, entered by the user.
isAutosave	Expected to be true if an autosave is being created.

Returns: kNoError on success, otherwise an error code.

Reimplemented from Engine.

◆ canSaveAutosaveCurrently()

bool Twp::TwpEngine::canSaveAutosaveCurrently ( )

inlineoverridevirtual

Indicate whether an autosave can currently be done.

Reimplemented from Engine.

◆ runDialog()

int Twp::TwpEngine::runDialog ( GUI::Dialog & dialog )

overridevirtual

Run a GUI dialog.

Reimplemented from Engine.

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

engines/twp/twp.h

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ run()

◆ getGameId()

◆ getRandomSource()

◆ hasFeature()

◆ canLoadGameStateCurrently()

◆ canSaveGameStateCurrently()

◆ saveGameStream()

◆ loadGameState()

◆ loadGameStream()

◆ saveGameState()

◆ canSaveAutosaveCurrently()

◆ runDialog()