ScummVM API documentation
Public Member Functions | Public Attributes | List of all members
Hypno::HypnoEngine Class Reference
Inheritance diagram for Hypno::HypnoEngine:
Engine Hypno::BoyzEngine Hypno::SpiderEngine Hypno::WetEngine

Public Member Functions

 HypnoEngine (OSystem *syst, const ADGameDescription *gd)
 
bool isDemo () const
 
Common::Error run () override
 
virtual void resetSceneState ()
 
bool checkSceneCompleted ()
 
bool checkLevelWon ()
 
void runLevel (Common::String &name)
 
void runScene (Scene *scene)
 
virtual void runBeforeArcade (ArcadeShooting *arc)
 
virtual void runAfterArcade (ArcadeShooting *arc)
 
void runArcade (ArcadeShooting *arc)
 
virtual void runCode (Code *code)
 
void runTransition (Transition *trans)
 
void restartGame ()
 
void clearAreas ()
 
void initializePath (const Common::FSNode &gamePath) override
 
virtual void loadAssets ()
 
void splitArcadeFile (const Common::String &filename, Common::String &arc, Common::String &list)
 
void parseArcadeShooting (const Common::String &prefix, const Common::String &name, const Common::String &data)
 
SegmentShootsSequence parseShootList (const Common::String &name, const Common::String &data)
 
void loadArcadeLevel (const Common::String &current, const Common::String &nextWin, const Common::String &nextLose, const Common::String &prefix)
 
void loadSceneLevel (const Common::String &current, const Common::String &next, const Common::String &prefix)
 
void loadSceneLevel (const char *buf, const Common::String &name, const Common::String &next, const Common::String &prefix)
 
LibFile * loadLib (const Common::Path &prefix, const Common::Path &filename, bool encrypted)
 
void clickedHotspot (Common::Point)
 
virtual bool hoverHotspot (Common::Point)
 
bool cursorPauseMovie (Common::Point)
 
bool cursorExit (Common::Point)
 
bool cursorMask (Common::Point)
 
virtual void loadGame (const Common::String &nextLevel, int score, int puzzleDifficulty, int combatDifficulty)
 
bool canLoadGameStateCurrently (Common::U32String *msg=nullptr) override
 
bool canSaveAutosaveCurrently () override
 
bool canSaveGameStateCurrently (Common::U32String *msg=nullptr) override
 
Common::Path convertPath (const Common::String &)
 
void playVideo (MVideo &video)
 
void skipVideo (MVideo &video)
 
Graphics::Surface * decodeFrame (const Common::String &name, int frame, byte **palette=nullptr)
 
Frames decodeFrames (const Common::String &name)
 
void loadImage (const Common::String &file, int x, int y, bool transparent, bool palette=false, int frameNumber=0)
 
void drawImage (Graphics::Surface &image, int x, int y, bool transparent)
 
void loadPalette (const Common::String &fname)
 
void loadPalette (const byte *palette, uint32 offset, uint32 size)
 
byte * getPalette (uint32 idx)
 
void disableCursor ()
 
void defaultCursor ()
 
virtual void changeCursor (const Common::String &cursor, uint32 n, bool centerCursor=false)
 
virtual void changeCursor (const Common::String &cursor)
 
virtual void changeCursor (const Graphics::Surface &entry, byte *palette, bool centerCursor=false)
 
virtual void runMenu (Hotspots *hs, bool only_menu=false)
 
void runBackground (Background *a)
 
void runOverlay (Overlay *a)
 
void runMice (Mice *a)
 
void runEscape ()
 
void runSave (Save *a)
 
void runLoad (Load *a)
 
void runLoadCheckpoint (LoadCheckpoint *a)
 
void runTimer (Timer *a)
 
void runQuit (Quit *a)
 
void runCutscene (Cutscene *a)
 
void runIntro (Intro *a)
 
void runPlay (Play *a)
 
void runSound (Sound *a)
 
void runPalette (Palette *a)
 
void runAmbient (Ambient *a)
 
void runWalN (WalN *a)
 
bool runGlobal (Global *a)
 
void runTalk (Talk *a)
 
void runSwapPointer (SwapPointer *a)
 
void runChangeLevel (ChangeLevel *a)
 
virtual void drawBackToMenu (Hotspot *h)
 
void changeScreenMode (const Common::String &mode)
 
void updateScreen (MVideo &video)
 
void updateVideo (MVideo &video)
 
void drawScreen ()
 
void runIntro (MVideo &video)
 
void runIntros (Videos &videos)
 
virtual Common::String findNextLevel (const Common::String &level)
 
virtual Common::String findNextLevel (const Transition *trans)
 
void playSound (const Filename &filename, uint32 loops, uint32 sampleRate=22050, bool stereo=false)
 
void stopSound ()
 
virtual bool availableObjectives ()
 
virtual bool checkArcadeObjectives ()
 
virtual bool checkTransition (ArcadeTransitions &transitions, ArcadeShooting *arc)
 
virtual Common::Point getPlayerPosition (bool needsUpdate)
 
virtual Common::Point computeTargetPosition (const Common::Point &mousePos)
 
virtual int detectTarget (const Common::Point &mousePos)
 
virtual void pressedKey (const int keycode)
 
virtual bool clickedPrimaryShoot (const Common::Point &mousePos)
 
virtual bool clickedSecondaryShoot (const Common::Point &mousePos)
 
virtual void drawShoot (const Common::Point &mousePos)
 
virtual bool shoot (const Common::Point &mousePos, ArcadeShooting *arc, bool secondary)
 
virtual void hitPlayer ()
 
virtual void missedTarget (Shoot *s, ArcadeShooting *arc)
 
virtual void missNoTarget (ArcadeShooting *arc)
 
virtual byte * getTargetColor (Common::String name, int levelId)
 
virtual void findNextSegment (ArcadeShooting *arc)
 
virtual void initSegment (ArcadeShooting *arc)
 
void resetStatistics ()
 
void incLivesUsed ()
 
void incShotsFired ()
 
void incEnemyHits ()
 
void incEnemyTargets ()
 
void incTargetsDestroyed ()
 
void incTargetsMissed ()
 
void incFriendliesEncountered ()
 
void incInfoReceived ()
 
void incScore (int inc)
 
void incBonus (int inc)
 
uint32 killRatio ()
 
uint32 accuracyRatio ()
 
virtual void drawCursorArcade (const Common::Point &mousePos)
 
virtual void drawPlayer ()
 
virtual void drawHealth ()
 
virtual void drawAmmo ()
 
virtual void loadFonts (const Common::String prefix="")
 
virtual void drawString (const Filename &name, const Common::String &str, int x, int y, int w, uint32 c)
 
virtual void showConversation ()
 
virtual void endConversation ()
 
virtual void rightClickedConversation (const Common::Point &mousePos)
 
virtual void leftClickedConversation (const Common::Point &mousePos)
 
virtual bool hoverConversation (const Common::Point &mousePos)
 
virtual void showCredits ()
 
bool startAlarm (uint32, Common::String *)
 
bool startCountdown (uint32)
 
void removeTimers ()
 
- 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
 
 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 ()
 
virtual bool hasFeature (EngineFeature f) const
 
bool enhancementEnabled (int32 cls)
 
virtual void syncSoundSettings ()
 
virtual void applyGameSettings ()
 
virtual void flipMute ()
 
virtual Common::String getSaveStateName (int slot) const
 
virtual Common::Error loadGameState (int slot)
 
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)
 
bool saveGameDialog ()
 
bool loadGameDialog ()
 

Public Attributes

const ADGameDescription * _gameDescription
 
Common::Language _language
 
Common::Platform _platform
 
Common::String _variant
 
bool _cheatsEnabled
 
bool _infiniteHealthCheat
 
bool _infiniteAmmoCheat
 
bool _unlockAllLevels
 
bool _restoredContentEnabled
 
Audio::SoundHandle _soundHandle
 
Common::InstallShieldV3 _installerArchive
 
Common::List< LibFile * > _archive
 
Levels _levels
 
Common::HashMap< Common::String, int > _sceneState
 
Common::String _checkpoint
 
Common::Path _prefixDir
 
Common::String _defaultCursor
 
uint32 _defaultCursorIdx
 
CursorCache * _cursorCache
 
int _screenW
 
int _screenH
 
Graphics::PixelFormat _pixelFormat
 
Graphics::Surface * _compositeSurface
 
uint32 _transparentColor
 
Common::Rect screenRect
 
Common::HashMap< Filename, bool > _intros
 
Common::String _nextLevel
 
Common::String _currentLevel
 
uint32 _levelId
 
Hotspots * _nextHotsToAdd
 
Hotspots * _nextHotsToRemove
 
HotspotsStack stack
 
Videos _nextSequentialVideoToPlay
 
Videos _nextParallelVideoToPlay
 
Videos _escapeSequentialVideoToPlay
 
Videos _videosPlaying
 
Videos _videosLooping
 
MVideo * _masks
 
MVideo * _additionalVideo
 
const Graphics::Surface * _mask
 
Filename _soundPath
 
Filename _music
 
int _musicRate
 
bool _musicStereo
 
bool _doNotStopSounds
 
Common::String _arcadeMode
 
MVideo * _background
 
Filename _currentPalette
 
ArcadeTransitions _transitions
 
Segments _segments
 
uint32 _segmentIdx
 
uint32 _segmentOffset
 
uint32 _segmentRepetition
 
uint32 _segmentRepetitionMax
 
uint32 _segmentShootSequenceOffset
 
uint32 _segmentShootSequenceMax
 
ShootSequence _shootSequence
 
ArcadeStats _stats
 
Common::String _difficulty
 
bool _skipLevel
 
bool _loseLevel
 
bool _skipDefeatVideo
 
bool _skipNextVideo
 
int _health
 
int _maxHealth
 
int _ammo
 
int _maxAmmo
 
int _score
 
int _bonus
 
int _lives
 
Common::String _healthString
 
Common::String _scoreString
 
Common::String _objString
 
Common::String _targetString
 
Common::String _directionString
 
Common::String _enterNameString
 
Filename _shootSound
 
Filename _hitSound
 
Filename _additionalSound
 
Shoots _shoots
 
Frames _playerFrames
 
int _playerFrameIdx
 
Common::List< int > _playerFrameSeps
 
int _playerFrameStart
 
int _playerFrameSep
 
int _playerFrameEnd
 
uint32 _objIdx
 
uint32 _objKillsCount [2]
 
uint32 _objMissesCount [2]
 
uint32 _objKillsRequired [2]
 
uint32 _objMissesAllowed [2]
 
Common::BitArray _font05
 
Common::BitArray _font08
 
Actions _conversation
 
bool _refreshConversation
 
int32 _countdown
 
bool _timerStarted
 
bool _keepTimerDuringScenes
 
Common::RandomSource * _rnd
 
- 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 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
 
int32 _activeEnhancements = kEnhGameBreakingBugFixes
 

Member Function Documentation

◆ run()

Common::Error Hypno::HypnoEngine::run ( )
overridevirtual

Initialize the engine and start its main loop.

Returns
kNoError on success, otherwise an error code.

Implements Engine.

◆ initializePath()

void Hypno::HypnoEngine::initializePath ( const Common::FSNode &  gamePath)
overridevirtual

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
gamePathThe base directory of the game data.

Reimplemented from Engine.

◆ canLoadGameStateCurrently()

bool Hypno::HypnoEngine::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.

◆ canSaveAutosaveCurrently()

bool Hypno::HypnoEngine::canSaveAutosaveCurrently ( )
inlineoverridevirtual

Indicate whether an autosave can currently be done.

Reimplemented from Engine.

Reimplemented in Hypno::SpiderEngine.

◆ canSaveGameStateCurrently()

bool Hypno::HypnoEngine::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.

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