ScummVM
Kyra::KyraEngine_v1 Class Referenceabstract

#include <kyra_v1.h>

Inheritance diagram for Kyra::KyraEngine_v1:
Collaboration diagram for Kyra::KyraEngine_v1:

Classes

struct  Event
 
struct  SaveHeader
 

Public Types

enum  kVolumeEntry { kVolumeMusic = 0, kVolumeSfx = 1, kVolumeSpeech = 2 }
 
- Public Types inherited from Engine
enum  EngineFeature {
  kSupportsSubtitleOptions, kSupportsRTL, kSupportsLoadingDuringRuntime, kSupportsSavingDuringRuntime,
  kSupportsJoystick
}
 A feature in this context means an ability of the engine which can be either available or not. More...
 

Public Member Functions

 KyraEngine_v1 (OSystem *system, const GameFlags &flags)
 
virtual ~KyraEngine_v1 ()
 
uint8 game () const
 
const GameFlagsgameFlags () const
 
Resourceresource ()
 
virtual Screenscreen ()=0
 
virtual TextDisplayertext ()
 
virtual GUIgui () const
 
Soundsound ()
 
StaticResourcestaticres ()
 
TimerManagertimer ()
 
uint32 tickLength () const
 
void setMousePos (int x, int y)
 
Common::Point getMousePos ()
 
bool speechEnabled ()
 
bool textEnabled ()
 
void setVolume (kVolumeEntry vol, uint8 value)
 
uint8 getVolume (kVolumeEntry vol)
 
virtual void syncSoundSettings ()
 Notify the engine that the sound settings in the config manager may have changed and that it hence should adjust any internal volume etc. More...
 
int setGameFlag (int flag)
 
int queryGameFlag (int flag) const
 
int resetGameFlag (int flag)
 
virtual void snd_playTheme (int file, int track)
 
virtual void snd_playSoundEffect (int id, int volume=0xFF)
 
virtual void snd_playWanderScoreViaMap (int command, int restart)
 
virtual void snd_playVoiceFile (int id)=0
 
virtual bool snd_voiceIsPlaying ()
 
virtual void snd_stopVoice ()
 
virtual void delayUntil (uint32 timestamp, bool updateGameTimers=false, bool update=false, bool isMainLoop=false)
 
virtual void delay (uint32 millis, bool update=false, bool isMainLoop=false)
 
virtual void delayWithTicks (int ticks)
 
- Public Member Functions inherited from Engine
void pauseEngine (bool pause)
 Pause or resume the engine. More...
 
bool isPaused () const
 Return whether the engine is currently paused or not. More...
 
void openMainMenuDialog ()
 Run the Global Main Menu Dialog. More...
 
uint32 getTotalPlayTime () const
 Get the total play time. More...
 
void setTotalPlayTime (uint32 time=0)
 Set the game time counter to the specified time. More...
 
Common::TimerManagergetTimerManager ()
 
Common::EventManagergetEventManager ()
 
Common::SaveFileManagergetSaveFileManager ()
 
void checkCD ()
 On some systems, check if the game appears to be run from CD. More...
 
 Engine (OSystem *syst)
 
virtual ~Engine ()
 
virtual void initializePath (const Common::FSNode &gamePath)
 Init SearchMan according to the game path. More...
 
virtual void errorString (const char *buf_input, char *buf_output, int buf_output_size)
 Prepare an error string, which is printed by the error() function. More...
 
virtual void initKeymap ()
 
virtual void deinitKeymap ()
 
virtual void flipMute ()
 Flip mute all sound option. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 

Public Attributes

Common::RandomSource _rnd
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Types

enum  ReadSaveHeaderError { kRSHENoError = 0, kRSHEInvalidType = 1, kRSHEInvalidVersion = 2, kRSHEIoError = 3 }
 
typedef Common::HashMap< Common::KeyCode, int16, KeyCodeHashKeyMap
 

Protected Member Functions

virtual Common::Error init ()
 
virtual Common::Error go ()=0
 
virtual Common::Error run ()
 Init the engine and start its main loop. More...
 
virtual ::GUI::DebuggergetDebugger ()
 Return the engine's debugger instance, if any. More...
 
virtual bool hasFeature (EngineFeature f) const
 Determine whether the engine supports the specified feature. More...
 
virtual void pauseEngineIntern (bool pause)
 Actual implementation of pauseEngine by subclasses. More...
 
void setupKeyMap ()
 
void updateInput ()
 
int checkInput (Button *buttonList, bool mainLoop=false, int eventFlag=0x8000)
 
void removeInputTop ()
 
virtual void registerDefaultSettings ()
 
virtual void readSettings ()
 
virtual void writeSettings ()
 
virtual bool skipFlag () const
 
virtual void resetSkipFlag (bool removeEvent=true)
 
virtual void setupTimers ()=0
 
virtual void setWalkspeed (uint8 speed)=0
 
virtual void setupOpcodeTable ()=0
 
int o1_queryGameFlag (EMCState *script)
 
int o1_setGameFlag (EMCState *script)
 
int o1_resetGameFlag (EMCState *script)
 
int o1_getRand (EMCState *script)
 
int o1_hideMouse (EMCState *script)
 
int o1_showMouse (EMCState *script)
 
int o1_setMousePos (EMCState *script)
 
int o1_setHandItem (EMCState *script)
 
int o1_removeHandItem (EMCState *script)
 
int o1_getMouseState (EMCState *script)
 
int o1_setDeathHandler (EMCState *script)
 
int o1_playWanderScoreViaMap (EMCState *script)
 
int o1_fillRect (EMCState *script)
 
int o1_blockInWalkableRegion (EMCState *script)
 
int o1_blockOutWalkableRegion (EMCState *script)
 
int o1_playSoundEffect (EMCState *script)
 
virtual void setHandItem (Item item)=0
 
virtual void removeHandItem ()=0
 
virtual int convertVolumeToMixer (int value)
 
virtual int convertVolumeFromMixer (int value)
 
virtual int findWay (int x, int y, int toX, int toY, int *moveTable, int moveTableSize)
 
int findSubPath (int x, int y, int toX, int toY, int *moveTable, int start, int end)
 
int getFacingFromPointToPoint (int x, int y, int toX, int toY)
 
int getOppositeFacingDirection (int dir)
 
void changePosTowardsFacing (int &x, int &y, int facing)
 
int getMoveTableSize (int *moveTable)
 
virtual bool lineIsPassable (int x, int y)=0
 
void checkAutosave ()
 
bool canLoadGameStateCurrently ()
 Indicates whether a game state can be loaded. More...
 
bool canSaveGameStateCurrently ()
 Indicates whether a game state can be saved. More...
 
const char * getSavegameFilename (int num)
 
bool saveFileLoadable (int slot)
 
void loadGameStateCheck (int slot)
 
virtual Common::Error loadGameState (int slot)=0
 Load a game state. More...
 
Common::Error saveGameState (int slot, const Common::String &desc)
 Save a game state. More...
 
virtual Common::Error saveGameStateIntern (int slot, const char *saveName, const Graphics::Surface *thumbnail)=0
 
Common::SeekableReadStreamopenSaveForReading (const char *filename, SaveHeader &header, bool checkID=true)
 
Common::OutSaveFileopenSaveForWriting (const char *filename, const char *saveName, const Graphics::Surface *thumbnail) const
 
virtual Graphics::SurfacegenerateSaveThumbnail () const
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
bool shouldPerformAutoSave (int lastSaveTime)
 Indicate whether an autosave should be performed. More...
 

Static Protected Member Functions

static Common::String getSavegameFilename (const Common::String &target, int num)
 
static WARN_UNUSED_RESULT ReadSaveHeaderError readSaveHeader (Common::SeekableReadStream *file, SaveHeader &header, bool skipThumbnail=true)
 

Protected Attributes

Resource_res
 
Sound_sound
 
TextDisplayer_text
 
StaticResource_staticres
 
TimerManager_timer
 
EMCInterpreter_emc
 
Debugger_debugger
 
int _mouseX
 
int _mouseY
 
Common::List< Event_eventList
 
KeyMap _keyMap
 
uint8 _configWalkspeed
 
int _configMusic
 
bool _configSounds
 
uint8 _configVoice
 
Common::RenderMode _configRenderMode
 
uint16 _tickLength
 
uint16 _gameSpeed
 
int8 _deathHandler
 
GameFlags _flags
 
Common::Array< const Opcode * > _opcodes
 
int _mouseState
 
uint8 _flagsTable [100]
 
Audio::SoundHandle _speechHandle
 
int _curMusicTheme
 
int _curSfxFile
 
int16 _lastMusicCommand
 
const int8_trackMap
 
int _trackMapSize
 
int _gameToLoad
 
uint32 _lastAutosave
 
bool _isSaveAllowed
 
Common::String _savegameFilename
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 

Static Protected Attributes

static const int8 _addXPosTable []
 
static const int8 _addYPosTable []
 
static const int8 _charAddXPosTable []
 
static const int8 _charAddYPosTable []
 

Friends

class Debugger
 
class ::KyraMetaEngine
 
class GUI
 
class GUI_v1
 
class GUI_EoB
 
class SoundMidiPC
 
class SeqPlayer_HOF
 
class TransferPartyWiz
 

Additional Inherited Members

- Static Public Member Functions inherited from Engine
static void quitGame ()
 Request the engine to quit. More...
 
static bool shouldQuit ()
 Return whether the ENGINE should quit respectively should return to the launcher. More...
 
static bool warnUserAboutUnsupportedGame ()
 Display a warning to the user that the game is not fully supported. More...
 

Detailed Description

Definition at line 178 of file kyra_v1.h.

Member Typedef Documentation

◆ KeyMap

Definition at line 291 of file kyra_v1.h.

Member Enumeration Documentation

◆ kVolumeEntry

Enumerator
kVolumeMusic 
kVolumeSfx 
kVolumeSpeech 

Definition at line 215 of file kyra_v1.h.

◆ ReadSaveHeaderError

Enumerator
kRSHENoError 
kRSHEInvalidType 
kRSHEInvalidVersion 
kRSHEIoError 

Definition at line 413 of file kyra_v1.h.

Constructor & Destructor Documentation

◆ KyraEngine_v1()

Kyra::KyraEngine_v1::KyraEngine_v1 ( OSystem system,
const GameFlags flags 
)

Definition at line 35 of file kyra_v1.cpp.

◆ ~KyraEngine_v1()

Kyra::KyraEngine_v1::~KyraEngine_v1 ( )
virtual

Definition at line 205 of file kyra_v1.cpp.

Member Function Documentation

◆ canLoadGameStateCurrently()

bool Kyra::KyraEngine_v1::canLoadGameStateCurrently ( )
inlineprotectedvirtual

Indicates whether a game state can be loaded.

Reimplemented from Engine.

Definition at line 393 of file kyra_v1.h.

◆ canSaveGameStateCurrently()

bool Kyra::KyraEngine_v1::canSaveGameStateCurrently ( )
inlineprotectedvirtual

Indicates whether a game state can be saved.

Reimplemented from Engine.

Definition at line 394 of file kyra_v1.h.

◆ changePosTowardsFacing()

void Kyra::KyraEngine_v1::changePosTowardsFacing ( int x,
int y,
int  facing 
)
protected

Definition at line 274 of file scene_v1.cpp.

◆ checkAutosave()

void Kyra::KyraEngine_v1::checkAutosave ( )
protected

Definition at line 257 of file saveload.cpp.

◆ checkInput()

int Kyra::KyraEngine_v1::checkInput ( Button buttonList,
bool  mainLoop = false,
int  eventFlag = 0x8000 
)
protected

Definition at line 239 of file kyra_v1.cpp.

◆ convertVolumeFromMixer()

int Kyra::KyraEngine_v1::convertVolumeFromMixer ( int  value)
protectedvirtual

Reimplemented in Kyra::LoLEngine.

Definition at line 641 of file kyra_v1.cpp.

◆ convertVolumeToMixer()

int Kyra::KyraEngine_v1::convertVolumeToMixer ( int  value)
protectedvirtual

Reimplemented in Kyra::LoLEngine.

Definition at line 636 of file kyra_v1.cpp.

◆ delay()

void Kyra::KyraEngine_v1::delay ( uint32  millis,
bool  update = false,
bool  isMainLoop = false 
)
virtual

◆ delayUntil()

void Kyra::KyraEngine_v1::delayUntil ( uint32  timestamp,
bool  updateGameTimers = false,
bool  update = false,
bool  isMainLoop = false 
)
virtual

Reimplemented in Kyra::KyraRpgEngine, and Kyra::KyraEngine_LoK.

Definition at line 528 of file kyra_v1.cpp.

◆ delayWithTicks()

void Kyra::KyraEngine_v1::delayWithTicks ( int  ticks)
virtual

Reimplemented in Kyra::KyraEngine_LoK.

Definition at line 545 of file kyra_v1.cpp.

◆ findSubPath()

int Kyra::KyraEngine_v1::findSubPath ( int  x,
int  y,
int  toX,
int  toY,
int moveTable,
int  start,
int  end 
)
protected

Definition at line 141 of file scene_v1.cpp.

◆ findWay()

int Kyra::KyraEngine_v1::findWay ( int  x,
int  y,
int  toX,
int  toY,
int moveTable,
int  moveTableSize 
)
protectedvirtual

Reimplemented in Kyra::KyraEngine_v2, and Kyra::KyraEngine_LoK.

Definition at line 27 of file scene_v1.cpp.

◆ game()

uint8 Kyra::KyraEngine_v1::game ( ) const
inline

Definition at line 191 of file kyra_v1.h.

◆ gameFlags()

const GameFlags& Kyra::KyraEngine_v1::gameFlags ( ) const
inline

Definition at line 192 of file kyra_v1.h.

◆ generateSaveThumbnail()

virtual Graphics::Surface* Kyra::KyraEngine_v1::generateSaveThumbnail ( ) const
inlineprotectedvirtual

Reimplemented in Kyra::LoLEngine.

Definition at line 431 of file kyra_v1.h.

◆ getDebugger()

GUI::Debugger * Kyra::KyraEngine_v1::getDebugger ( )
protectedvirtual

Return the engine's debugger instance, if any.

Used by error() to invoke the debugger when a severe error is reported.

Reimplemented from Engine.

Definition at line 83 of file kyra_v1.cpp.

◆ getFacingFromPointToPoint()

int Kyra::KyraEngine_v1::getFacingFromPointToPoint ( int  x,
int  y,
int  toX,
int  toY 
)
protected

Definition at line 209 of file scene_v1.cpp.

◆ getMousePos()

Common::Point Kyra::KyraEngine_v1::getMousePos ( )

Definition at line 220 of file kyra_v1.cpp.

◆ getMoveTableSize()

int Kyra::KyraEngine_v1::getMoveTableSize ( int moveTable)
protected

Definition at line 279 of file scene_v1.cpp.

◆ getOppositeFacingDirection()

int Kyra::KyraEngine_v1::getOppositeFacingDirection ( int  dir)
protected

Definition at line 252 of file scene_v1.cpp.

◆ getSavegameFilename() [1/2]

const char * Kyra::KyraEngine_v1::getSavegameFilename ( int  num)
protected

Definition at line 232 of file saveload.cpp.

◆ getSavegameFilename() [2/2]

Common::String Kyra::KyraEngine_v1::getSavegameFilename ( const Common::String target,
int  num 
)
staticprotected

Definition at line 237 of file saveload.cpp.

◆ getVolume()

uint8 Kyra::KyraEngine_v1::getVolume ( kVolumeEntry  vol)

Definition at line 668 of file kyra_v1.cpp.

◆ go()

virtual Common::Error Kyra::KyraEngine_v1::go ( )
protectedpure virtual

◆ gui()

virtual GUI* Kyra::KyraEngine_v1::gui ( ) const
inlinevirtual

◆ hasFeature()

bool Kyra::KyraEngine_v1::hasFeature ( EngineFeature  f) const
protectedvirtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Definition at line 197 of file detection.cpp.

◆ init()

Common::Error Kyra::KyraEngine_v1::init ( void  )
protectedvirtual

◆ lineIsPassable()

virtual bool Kyra::KyraEngine_v1::lineIsPassable ( int  x,
int  y 
)
protectedpure virtual

◆ loadGameState()

virtual Common::Error Kyra::KyraEngine_v1::loadGameState ( int  slot)
protectedpure virtual

Load a game state.

Parameters
slotthe slot from which a savestate should be loaded
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Implemented in Kyra::LoLEngine, Kyra::EoBCoreEngine, Kyra::KyraEngine_HoF, Kyra::KyraEngine_MR, Kyra::KyraRpgEngine, and Kyra::KyraEngine_LoK.

◆ loadGameStateCheck()

void Kyra::KyraEngine_v1::loadGameStateCheck ( int  slot)
protected

Definition at line 264 of file saveload.cpp.

◆ o1_blockInWalkableRegion()

int Kyra::KyraEngine_v1::o1_blockInWalkableRegion ( EMCState script)
protected

Definition at line 107 of file script_v1.cpp.

◆ o1_blockOutWalkableRegion()

int Kyra::KyraEngine_v1::o1_blockOutWalkableRegion ( EMCState script)
protected

Definition at line 113 of file script_v1.cpp.

◆ o1_fillRect()

int Kyra::KyraEngine_v1::o1_fillRect ( EMCState script)
protected

Definition at line 101 of file script_v1.cpp.

◆ o1_getMouseState()

int Kyra::KyraEngine_v1::o1_getMouseState ( EMCState script)
protected

Definition at line 84 of file script_v1.cpp.

◆ o1_getRand()

int Kyra::KyraEngine_v1::o1_getRand ( EMCState script)
protected

Definition at line 45 of file script_v1.cpp.

◆ o1_hideMouse()

int Kyra::KyraEngine_v1::o1_hideMouse ( EMCState script)
protected

Definition at line 54 of file script_v1.cpp.

◆ o1_playSoundEffect()

int Kyra::KyraEngine_v1::o1_playSoundEffect ( EMCState script)
protected

Definition at line 119 of file script_v1.cpp.

◆ o1_playWanderScoreViaMap()

int Kyra::KyraEngine_v1::o1_playWanderScoreViaMap ( EMCState script)
protected

Definition at line 95 of file script_v1.cpp.

◆ o1_queryGameFlag()

int Kyra::KyraEngine_v1::o1_queryGameFlag ( EMCState script)
protected

Definition at line 30 of file script_v1.cpp.

◆ o1_removeHandItem()

int Kyra::KyraEngine_v1::o1_removeHandItem ( EMCState script)
protected

Definition at line 78 of file script_v1.cpp.

◆ o1_resetGameFlag()

int Kyra::KyraEngine_v1::o1_resetGameFlag ( EMCState script)
protected

Definition at line 40 of file script_v1.cpp.

◆ o1_setDeathHandler()

int Kyra::KyraEngine_v1::o1_setDeathHandler ( EMCState script)
protected

Definition at line 89 of file script_v1.cpp.

◆ o1_setGameFlag()

int Kyra::KyraEngine_v1::o1_setGameFlag ( EMCState script)
protected

Definition at line 35 of file script_v1.cpp.

◆ o1_setHandItem()

int Kyra::KyraEngine_v1::o1_setHandItem ( EMCState script)
protected

Definition at line 72 of file script_v1.cpp.

◆ o1_setMousePos()

int Kyra::KyraEngine_v1::o1_setMousePos ( EMCState script)
protected

Definition at line 66 of file script_v1.cpp.

◆ o1_showMouse()

int Kyra::KyraEngine_v1::o1_showMouse ( EMCState script)
protected

Definition at line 60 of file script_v1.cpp.

◆ openSaveForReading()

Common::SeekableReadStream * Kyra::KyraEngine_v1::openSaveForReading ( const char *  filename,
SaveHeader header,
bool  checkID = true 
)
protected

Definition at line 138 of file saveload.cpp.

◆ openSaveForWriting()

Common::OutSaveFile * Kyra::KyraEngine_v1::openSaveForWriting ( const char *  filename,
const char *  saveName,
const Graphics::Surface thumbnail 
) const
protected

Definition at line 187 of file saveload.cpp.

◆ pauseEngineIntern()

void Kyra::KyraEngine_v1::pauseEngineIntern ( bool  pause)
protectedvirtual

Actual implementation of pauseEngine by subclasses.

See there for details.

Reimplemented from Engine.

Reimplemented in Kyra::LoLEngine, Kyra::KyraEngine_v2, and Kyra::KyraEngine_HoF.

Definition at line 87 of file kyra_v1.cpp.

◆ queryGameFlag()

int Kyra::KyraEngine_v1::queryGameFlag ( int  flag) const

Definition at line 517 of file kyra_v1.cpp.

◆ readSaveHeader()

WARN_UNUSED_RESULT KyraEngine_v1::ReadSaveHeaderError Kyra::KyraEngine_v1::readSaveHeader ( Common::SeekableReadStream file,
SaveHeader header,
bool  skipThumbnail = true 
)
staticprotected

Definition at line 40 of file saveload.cpp.

◆ readSettings()

void Kyra::KyraEngine_v1::readSettings ( )
protectedvirtual

◆ registerDefaultSettings()

void Kyra::KyraEngine_v1::registerDefaultSettings ( )
protectedvirtual

◆ removeHandItem()

virtual void Kyra::KyraEngine_v1::removeHandItem ( )
protectedpure virtual

◆ removeInputTop()

void Kyra::KyraEngine_v1::removeInputTop ( )
protected

Definition at line 485 of file kyra_v1.cpp.

◆ resetGameFlag()

int Kyra::KyraEngine_v1::resetGameFlag ( int  flag)

Definition at line 522 of file kyra_v1.cpp.

◆ resetSkipFlag()

void Kyra::KyraEngine_v1::resetSkipFlag ( bool  removeEvent = true)
protectedvirtual

Reimplemented in Kyra::KyraEngine_LoK, and Kyra::KyraEngine_MR.

Definition at line 498 of file kyra_v1.cpp.

◆ resource()

Resource* Kyra::KyraEngine_v1::resource ( )
inline

Definition at line 195 of file kyra_v1.h.

◆ run()

virtual Common::Error Kyra::KyraEngine_v1::run ( )
inlineprotectedvirtual

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 250 of file kyra_v1.h.

◆ saveFileLoadable()

bool Kyra::KyraEngine_v1::saveFileLoadable ( int  slot)
protected

Definition at line 242 of file saveload.cpp.

◆ saveGameState()

Common::Error Kyra::KyraEngine_v1::saveGameState ( int  slot,
const Common::String desc 
)
inlineprotectedvirtual

Save a game state.

Parameters
slotthe slot into which the savestate should be stored
desca description for the savestate, entered by the user
Returns
returns kNoError on success, else an error code.

Reimplemented from Engine.

Definition at line 424 of file kyra_v1.h.

◆ saveGameStateIntern()

virtual Common::Error Kyra::KyraEngine_v1::saveGameStateIntern ( int  slot,
const char *  saveName,
const Graphics::Surface thumbnail 
)
protectedpure virtual

◆ screen()

virtual Screen* Kyra::KyraEngine_v1::screen ( )
pure virtual

◆ setGameFlag()

int Kyra::KyraEngine_v1::setGameFlag ( int  flag)

Definition at line 511 of file kyra_v1.cpp.

◆ setHandItem()

virtual void Kyra::KyraEngine_v1::setHandItem ( Item  item)
protectedpure virtual

◆ setMousePos()

void Kyra::KyraEngine_v1::setMousePos ( int  x,
int  y 
)

Definition at line 231 of file kyra_v1.cpp.

◆ setupKeyMap()

void Kyra::KyraEngine_v1::setupKeyMap ( )
protected

Definition at line 351 of file kyra_v1.cpp.

◆ setupOpcodeTable()

virtual void Kyra::KyraEngine_v1::setupOpcodeTable ( )
protectedpure virtual

◆ setupTimers()

virtual void Kyra::KyraEngine_v1::setupTimers ( )
protectedpure virtual

◆ setVolume()

void Kyra::KyraEngine_v1::setVolume ( kVolumeEntry  vol,
uint8  value 
)

Definition at line 645 of file kyra_v1.cpp.

◆ setWalkspeed()

virtual void Kyra::KyraEngine_v1::setWalkspeed ( uint8  speed)
protectedpure virtual

◆ skipFlag()

bool Kyra::KyraEngine_v1::skipFlag ( ) const
protectedvirtual

Reimplemented in Kyra::KyraEngine_LoK, and Kyra::KyraEngine_MR.

Definition at line 490 of file kyra_v1.cpp.

◆ snd_playSoundEffect()

void Kyra::KyraEngine_v1::snd_playSoundEffect ( int  id,
int  volume = 0xFF 
)
virtual

◆ snd_playTheme()

void Kyra::KyraEngine_v1::snd_playTheme ( int  file,
int  track 
)
virtual

Definition at line 257 of file sound.cpp.

◆ snd_playVoiceFile()

virtual void Kyra::KyraEngine_v1::snd_playVoiceFile ( int  id)
pure virtual

◆ snd_playWanderScoreViaMap()

void Kyra::KyraEngine_v1::snd_playWanderScoreViaMap ( int  command,
int  restart 
)
virtual

Reimplemented in Kyra::KyraEngine_LoK, and Kyra::KyraEngine_MR.

Definition at line 278 of file sound.cpp.

◆ snd_stopVoice()

void Kyra::KyraEngine_v1::snd_stopVoice ( )
virtual

Reimplemented in Kyra::KyraEngine_MR.

Definition at line 328 of file sound.cpp.

◆ snd_voiceIsPlaying()

bool Kyra::KyraEngine_v1::snd_voiceIsPlaying ( )
virtual

Reimplemented in Kyra::KyraEngine_MR.

Definition at line 332 of file sound.cpp.

◆ sound()

Sound* Kyra::KyraEngine_v1::sound ( )
inline

Definition at line 199 of file kyra_v1.h.

◆ speechEnabled()

bool Kyra::KyraEngine_v1::speechEnabled ( )

Definition at line 628 of file kyra_v1.cpp.

◆ staticres()

StaticResource* Kyra::KyraEngine_v1::staticres ( )
inline

Definition at line 200 of file kyra_v1.h.

◆ syncSoundSettings()

void Kyra::KyraEngine_v1::syncSoundSettings ( )
virtual

Notify the engine that the sound settings in the config manager may have changed and that it hence should adjust any internal volume etc.

values accordingly. The default implementation sets the volume levels of all mixer sound types according to the config entries of the active domain. When overwriting, call the default implementation first, then adjust the volumes further (if required).

Note
When setting volume levels, respect the "mute" config entry.
The volume for the plain sound type is reset to the maximum volume. If the engine can associate its own value for this type, it needs to overwrite this member and set it accordingly.
Todo:
find a better name for this

Reimplemented from Engine.

Definition at line 687 of file kyra_v1.cpp.

◆ text()

virtual TextDisplayer* Kyra::KyraEngine_v1::text ( )
inlinevirtual

Reimplemented in Kyra::KyraEngine_HoF.

Definition at line 197 of file kyra_v1.h.

◆ textEnabled()

bool Kyra::KyraEngine_v1::textEnabled ( )

Definition at line 632 of file kyra_v1.cpp.

◆ tickLength()

uint32 Kyra::KyraEngine_v1::tickLength ( ) const
inline

Definition at line 203 of file kyra_v1.h.

◆ timer()

TimerManager* Kyra::KyraEngine_v1::timer ( )
inline

Definition at line 201 of file kyra_v1.h.

◆ updateInput()

void Kyra::KyraEngine_v1::updateInput ( )
protected

Definition at line 440 of file kyra_v1.cpp.

◆ writeSettings()

void Kyra::KyraEngine_v1::writeSettings ( )
protectedvirtual

Friends And Related Function Documentation

◆ ::KyraMetaEngine

friend class ::KyraMetaEngine
friend

Definition at line 180 of file kyra_v1.h.

◆ Debugger

friend class Debugger
friend

Definition at line 179 of file kyra_v1.h.

◆ GUI

friend class GUI
friend

Definition at line 181 of file kyra_v1.h.

◆ GUI_EoB

friend class GUI_EoB
friend

Definition at line 183 of file kyra_v1.h.

◆ GUI_v1

friend class GUI_v1
friend

Definition at line 182 of file kyra_v1.h.

◆ SeqPlayer_HOF

friend class SeqPlayer_HOF
friend

Definition at line 185 of file kyra_v1.h.

◆ SoundMidiPC

friend class SoundMidiPC
friend

Definition at line 184 of file kyra_v1.h.

◆ TransferPartyWiz

friend class TransferPartyWiz
friend

Definition at line 186 of file kyra_v1.h.

Member Data Documentation

◆ _addXPosTable

const int8 Kyra::KyraEngine_v1::_addXPosTable
staticprotected
Initial value:
= {
4, 4, 0, -4, -4, -4, 0, 4
}

Definition at line 377 of file kyra_v1.h.

◆ _addYPosTable

const int8 Kyra::KyraEngine_v1::_addYPosTable
staticprotected
Initial value:
= {
0, -2, -2, -2, 0, 2, 2, 2
}

Definition at line 378 of file kyra_v1.h.

◆ _charAddXPosTable

const int8 Kyra::KyraEngine_v1::_charAddXPosTable
staticprotected
Initial value:
= {
0, 4, 4, 4, 0, -4, -4, -4
}

Definition at line 382 of file kyra_v1.h.

◆ _charAddYPosTable

const int8 Kyra::KyraEngine_v1::_charAddYPosTable
staticprotected
Initial value:
= {
-2, -2, 0, 2, 2, 2, 0, -2
}

Definition at line 383 of file kyra_v1.h.

◆ _configMusic

int Kyra::KyraEngine_v1::_configMusic
protected

Definition at line 301 of file kyra_v1.h.

◆ _configRenderMode

Common::RenderMode Kyra::KyraEngine_v1::_configRenderMode
protected

Definition at line 305 of file kyra_v1.h.

◆ _configSounds

bool Kyra::KyraEngine_v1::_configSounds
protected

Definition at line 302 of file kyra_v1.h.

◆ _configVoice

uint8 Kyra::KyraEngine_v1::_configVoice
protected

Definition at line 303 of file kyra_v1.h.

◆ _configWalkspeed

uint8 Kyra::KyraEngine_v1::_configWalkspeed
protected

Definition at line 299 of file kyra_v1.h.

◆ _curMusicTheme

int Kyra::KyraEngine_v1::_curMusicTheme
protected

Definition at line 358 of file kyra_v1.h.

◆ _curSfxFile

int Kyra::KyraEngine_v1::_curSfxFile
protected

Definition at line 359 of file kyra_v1.h.

◆ _deathHandler

int8 Kyra::KyraEngine_v1::_deathHandler
protected

Definition at line 315 of file kyra_v1.h.

◆ _debugger

Debugger* Kyra::KyraEngine_v1::_debugger
protected

Definition at line 270 of file kyra_v1.h.

◆ _emc

EMCInterpreter* Kyra::KyraEngine_v1::_emc
protected

Definition at line 269 of file kyra_v1.h.

◆ _eventList

Common::List<Event> Kyra::KyraEngine_v1::_eventList
protected

Definition at line 290 of file kyra_v1.h.

◆ _flags

GameFlags Kyra::KyraEngine_v1::_flags
protected

Definition at line 323 of file kyra_v1.h.

◆ _flagsTable

uint8 Kyra::KyraEngine_v1::_flagsTable[100]
protected

Definition at line 353 of file kyra_v1.h.

◆ _gameSpeed

uint16 Kyra::KyraEngine_v1::_gameSpeed
protected

Definition at line 312 of file kyra_v1.h.

◆ _gameToLoad

int Kyra::KyraEngine_v1::_gameToLoad
protected

Definition at line 386 of file kyra_v1.h.

◆ _isSaveAllowed

bool Kyra::KyraEngine_v1::_isSaveAllowed
protected

Definition at line 391 of file kyra_v1.h.

◆ _keyMap

KeyMap Kyra::KyraEngine_v1::_keyMap
protected

Definition at line 292 of file kyra_v1.h.

◆ _lastAutosave

uint32 Kyra::KyraEngine_v1::_lastAutosave
protected

Definition at line 388 of file kyra_v1.h.

◆ _lastMusicCommand

int16 Kyra::KyraEngine_v1::_lastMusicCommand
protected

Definition at line 360 of file kyra_v1.h.

◆ _mouseState

int Kyra::KyraEngine_v1::_mouseState
protected

Definition at line 347 of file kyra_v1.h.

◆ _mouseX

int Kyra::KyraEngine_v1::_mouseX
protected

Definition at line 278 of file kyra_v1.h.

◆ _mouseY

int Kyra::KyraEngine_v1::_mouseY
protected

Definition at line 278 of file kyra_v1.h.

◆ _opcodes

Common::Array<const Opcode *> Kyra::KyraEngine_v1::_opcodes
protected

Definition at line 327 of file kyra_v1.h.

◆ _res

Resource* Kyra::KyraEngine_v1::_res
protected

Definition at line 264 of file kyra_v1.h.

◆ _rnd

Common::RandomSource Kyra::KyraEngine_v1::_rnd

Definition at line 205 of file kyra_v1.h.

◆ _savegameFilename

Common::String Kyra::KyraEngine_v1::_savegameFilename
protected

Definition at line 397 of file kyra_v1.h.

◆ _sound

Sound* Kyra::KyraEngine_v1::_sound
protected

Definition at line 265 of file kyra_v1.h.

◆ _speechHandle

Audio::SoundHandle Kyra::KyraEngine_v1::_speechHandle
protected

Definition at line 356 of file kyra_v1.h.

◆ _staticres

StaticResource* Kyra::KyraEngine_v1::_staticres
protected

Definition at line 267 of file kyra_v1.h.

◆ _text

TextDisplayer* Kyra::KyraEngine_v1::_text
protected

Definition at line 266 of file kyra_v1.h.

◆ _tickLength

uint16 Kyra::KyraEngine_v1::_tickLength
protected

Definition at line 311 of file kyra_v1.h.

◆ _timer

TimerManager* Kyra::KyraEngine_v1::_timer
protected

Definition at line 268 of file kyra_v1.h.

◆ _trackMap

const int8* Kyra::KyraEngine_v1::_trackMap
protected

Definition at line 362 of file kyra_v1.h.

◆ _trackMapSize

int Kyra::KyraEngine_v1::_trackMapSize
protected

Definition at line 363 of file kyra_v1.h.


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