ScummVM API documentation
TeenAgent::TeenAgentEngine Class Reference
Inheritance diagram for TeenAgent::TeenAgentEngine:
Engine

Public Types

enum  Action { kActionNone, kActionExamine, kActionUse }
 
- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsReturnToLauncher, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsChangingOptionsDuringRuntime, kSupportsArbitraryResolutions, kSupportsHelp, kSupportsQuitDialogOverride
}
 

Public Member Functions

 TeenAgentEngine (OSystem *system, const ADGameDescription *gd)
 
Common::Error run () override
 
Common::String getSaveStateName (int slot) const override
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool hasFeature (EngineFeature f) const override
 
void init ()
 
void examine (const Common::Point &point, Object *object)
 
void use (Object *object)
 
void cancel ()
 
bool processCallback (uint16 addr)
 
ScenegetScene ()
 
bool showLogo ()
 
bool showCDLogo ()
 
bool showMetropolis ()
 
int skipEvents () const
 
Common::String parseMessage (uint16 addr)
 
void displayMessage (uint16 addr, byte color=textColorMark, uint16 x=0, uint16 y=0)
 
void displayMessage (const Common::String &str, byte color=textColorMark, uint16 x=0, uint16 y=0)
 
void displayAsyncMessage (uint16 addr, uint16 x, uint16 y, uint16 firstFrame, uint16 lastFrame, byte color=textColorMark)
 
void displayAsyncMessageInSlot (uint16 addr, byte slot, uint16 firstFrame, uint16 lastFrame, byte color=textColorMark)
 
void displayCredits (uint16 addr, uint16 timer=0)
 
void displayCutsceneMessage (uint16 addr, uint16 x, uint16 y)
 
void moveTo (const Common::Point &dst, byte o, bool warp=false)
 
void moveTo (uint16 x, uint16 y, byte o, bool warp=false)
 
void moveTo (Object *obj)
 
void moveRel (int16 x, int16 y, byte o, bool warp=false)
 
void playActorAnimation (uint16 id, bool async=false, bool ignore=false)
 
void playAnimation (uint16 id, byte slot, bool async=false, bool ignore=false, bool loop=false)
 
void loadScene (byte id, const Common::Point &pos, byte o=0)
 
void loadScene (byte id, uint16 x, uint16 y, byte o=0)
 
void enableOn (bool enable=true)
 
void setOns (byte id, byte value, byte sceneId=0)
 
void setLan (byte id, byte value, byte sceneId=0)
 
void setFlag (uint16 addr, byte value)
 
byte getFlag (uint16 addr)
 
void reloadLan ()
 
void rejectMessage ()
 
void playMusic (byte id)
 
void playSound (byte id, byte skipFrames)
 
void playSoundNow (Pack *pack, byte id)
 
void enableObject (byte id, byte sceneId=0)
 
void disableObject (byte id, byte sceneId=0)
 
void hideActor ()
 
void showActor ()
 
void waitAnimation ()
 
void waitLanAnimationFrame (byte slot, uint16 frame)
 
void setTimerCallback (uint16 addr, uint16 frames)
 
void shakeScreen ()
 
void displayCredits ()
 
void fadeIn ()
 
void fadeOut ()
 
void wait (uint16 frames)
 
void setMusic (byte id)
 
- 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::Error loadGameStream (Common::SeekableReadStream *stream)
 
void setGameToLoadSlot (int slot)
 
virtual Common::Error saveGameStream (Common::WriteStream *stream, bool isAutosave=false)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

Common::RandomSource _rnd
 
Resourcesres
 
Scenescene
 
Inventoryinventory
 
MusicPlayermusic
 
Dialogdialog
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Additional Inherited Members

- 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)
 
- 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

◆ run()

Common::Error TeenAgent::TeenAgentEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ getSaveStateName()

Common::String TeenAgent::TeenAgentEngine::getSaveStateName ( int  slot) const
overridevirtual

Generate the savegame filename.

Reimplemented from Engine.

◆ loadGameState()

Common::Error TeenAgent::TeenAgentEngine::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 TeenAgent::TeenAgentEngine::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.

◆ canLoadGameStateCurrently()

bool TeenAgent::TeenAgentEngine::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 TeenAgent::TeenAgentEngine::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.

◆ hasFeature()

bool TeenAgent::TeenAgentEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.


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