ScummVM API documentation
Supernova::SupernovaEngine Class Reference
Inheritance diagram for Supernova::SupernovaEngine:
Engine

Public Member Functions

 SupernovaEngine (OSystem *syst)
 
Common::Error run () override
 
Common::Error loadGameState (int slot) override
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Error saveGameState (int slot, const Common::String &desc, bool isAutosave=false) override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool hasFeature (EngineFeature f) const override
 
void pauseEngineIntern (bool pause) override
 
Common::Error loadGameStrings ()
 
void init ()
 
Common::String getSaveStateName (int slot) const override
 
bool loadGame (int slot)
 
bool saveGame (int slot, const Common::String &description)
 
bool serialize (Common::WriteStream *out)
 
bool deserialize (Common::ReadStream *in, int version)
 
bool quitGameDialog ()
 
void errorTempSave (bool saving)
 
void setTextSpeed ()
 
const Common::StringgetGameString (int idx) const
 
void setGameString (int idx, const Common::String &string)
 
void showHelpScreen1 ()
 
void showHelpScreen2 ()
 
Common::SeekableReadStreamgetBlockFromDatFile (Common::String name)
 
Common::Error showTextReader (const char *extension)
 
void playSound (AudioId sample)
 
void playSound (MusicId index)
 
void paletteFadeIn ()
 
void paletteFadeOut (int minBrightness=0)
 
void paletteBrightness ()
 
void renderImage (int section)
 
void renderImage (ImageId id, bool removeImage=false)
 
bool setCurrentImage (int filenumber)
 
void saveScreen (int x, int y, int width, int height)
 
void saveScreen (const GuiElement &guiElement)
 
void restoreScreen ()
 
void renderRoom (Room &room)
 
void renderMessage (const char *text, MessagePosition position=kMessageNormal)
 
void renderMessage (const Common::String &text, MessagePosition position=kMessageNormal)
 
void renderMessage (int stringId, MessagePosition position=kMessageNormal, Common::String var1="", Common::String var2="")
 
void renderMessage (int stringId, int x, int y)
 
void removeMessage ()
 
void renderText (const uint16 character)
 
void renderText (const char *text)
 
void renderText (const Common::String &text)
 
void renderText (int stringId)
 
void renderText (const uint16 character, int x, int y, byte color)
 
void renderText (const char *text, int x, int y, byte color)
 
void renderText (const Common::String &text, int x, int y, byte color)
 
void renderText (int stringId, int x, int y, byte color)
 
void renderText (const GuiElement &guiElement)
 
void renderBox (int x, int y, int width, int height, byte color)
 
void renderBox (const GuiElement &guiElement)
 
void setColor63 (byte value)
 
void stopSound ()
 
- 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

GameManager_gm
 
Sound_sound
 
ResourceManager_resMan
 
Screen_screen
 
bool _allowLoadGame
 
bool _allowSaveGame
 
Common::StringArray _gameStrings
 
Common::String _nullString
 
int _sleepAuoSaveVersion
 
Common::MemoryReadWriteStream_sleepAutoSave
 
uint _delay
 
int _textSpeed
 
char _MSPart
 
bool _improved
 
- 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 ()
 
- 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 Supernova::SupernovaEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ loadGameState()

Common::Error Supernova::SupernovaEngine::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.

◆ canLoadGameStateCurrently()

bool Supernova::SupernovaEngine::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.

◆ saveGameState()

Common::Error Supernova::SupernovaEngine::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.

◆ canSaveGameStateCurrently()

bool Supernova::SupernovaEngine::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.

◆ hasFeature()

bool Supernova::SupernovaEngine::hasFeature ( EngineFeature  f) const
overridevirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

◆ pauseEngineIntern()

void Supernova::SupernovaEngine::pauseEngineIntern ( bool  pause)
overridevirtual

Actual implementation of pauseEngine by subclasses.

See also
Engine::pauseEngine

Reimplemented from Engine.

◆ getSaveStateName()

Common::String Supernova::SupernovaEngine::getSaveStateName ( int  slot) const
overridevirtual

Generate the savegame filename.

Reimplemented from Engine.


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