ScummVM API documentation
Wage::WageEngine Class Reference
Inheritance diagram for Wage::WageEngine:
Engine

Public Member Functions

 WageEngine (OSystem *syst, const ADGameDescription *gameDesc)
 
bool hasFeature (EngineFeature f) const override
 
Common::Error run () override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
const char * getGameFile () const
 
void processTurn (Common::String *textInput, Designed *clickInput)
 
void regen ()
 
const char * getTargetName ()
 
bool pollEvent (Common::Event &event)
 
void takeObj (Obj *obj)
 
bool handleMoveCommand (Directions dir, const char *dirName)
 
bool handleLookCommand ()
 
Common::StringgetGroundItemsList (Scene *scene)
 
void appendObjNames (Common::String &str, const ObjArray &objs)
 
bool handleInventoryCommand ()
 
bool handleStatusCommand ()
 
bool handleRestCommand ()
 
bool handleAcceptCommand ()
 
bool handleTakeCommand (const char *target)
 
bool handleDropCommand (const char *target)
 
bool handleAimCommand (const char *target)
 
bool handleWearCommand (const char *target)
 
bool handleOfferCommand (const char *target)
 
void wearObj (Obj *o, int pos)
 
bool tryAttack (const Obj *weapon, const Common::String &input)
 
bool handleAttack (Obj *weapon)
 
void printPlayerCondition (Chr *player)
 
const char * getPercentMessage (double percent)
 
void playSound (Common::String soundName)
 
void updateSoundTimerForScene (Scene *scene, bool firstTime)
 
void setMenu (Common::String soundName)
 
void appendText (const char *str)
 
void gameOver ()
 
bool saveDialog ()
 
void aboutDialog ()
 
ObjgetOffer ()
 
ChrgetMonster ()
 
void processEvents ()
 
ScenegetSceneByName (Common::String &location)
 
void onMove (Designed *what, Designed *from, Designed *to)
 
void encounter (Chr *player, Chr *chr)
 
void redrawScene ()
 
void saveGame ()
 
uint32 getFeatures ()
 
Common::Error loadGameState (int slot) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
bool scummVMSaveLoadDialog (bool isSave)
 
- 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::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 ()
 

Public Attributes

Common::RandomSource_rnd
 
Gui_gui
 
World_world
 
Scene_lastScene
 
int _loopCount
 
int _turn
 
Chr_monster
 
Chr_running
 
Obj_offer
 
int _aim
 
int _opponentAim
 
bool _temporarilyHidden
 
bool _isGameOver
 
bool _commandWasQuick
 
bool _restartRequested = false
 
bool _shouldQuit
 
int _defaultSaveSlot = -1
 
Common::String _defaultSaveDescritpion
 
Common::String _inputText
 
Common::List< int > _soundQueue
 
Common::String _soundToPlay
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

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

◆ hasFeature()

bool Wage::WageEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ run()

Common::Error Wage::WageEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ canLoadGameStateCurrently()

bool Wage::WageEngine::canLoadGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be loaded.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ canSaveGameStateCurrently()

bool Wage::WageEngine::canSaveGameStateCurrently ( Common::U32String msg = nullptr)
overridevirtual

Indicate whether a game state can be saved.

Parameters
msgOptional pointer to message explaining why it is disabled

Reimplemented from Engine.

◆ loadGameState()

Common::Error Wage::WageEngine::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 Wage::WageEngine::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: