ScummVM
Parallaction::Parallaction Class Referenceabstract

#include <parallaction.h>

Inheritance diagram for Parallaction::Parallaction:
Collaboration diagram for Parallaction::Parallaction:

Public Member Functions

int getGameType () const
 
uint32 getFeatures () const
 
Common::Language getLanguage () const
 
Common::Platform getPlatform () const
 
 Parallaction (OSystem *syst, const PARALLACTIONGameDescription *gameDesc)
 
 ~Parallaction ()
 
virtual Common::Error init ()
 
virtual Common::Error go ()=0
 
virtual Common::Error run ()
 Init the engine and start its main loop. 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...
 
virtual GUI::DebuggergetDebugger ()
 Return the engine's debugger instance, if any. More...
 
void beep ()
 
void pauseJobs ()
 
void resumeJobs ()
 
uint getInternLanguage ()
 
void setInternLanguage (uint id)
 
void enterDialogueMode (ZonePtr z)
 
void scheduleLocationSwitch (const char *location)
 
void showSlide (const char *name, int x=0, int y=0)
 
void setLocationFlags (uint32 flags)
 
void clearLocationFlags (uint32 flags)
 
void toggleLocationFlags (uint32 flags)
 
uint32 getLocationFlags ()
 
bool checkSpecialZoneBox (ZonePtr z, uint32 type, uint x, uint y)
 
bool checkZoneBox (ZonePtr z, uint32 type, uint x, uint y)
 
bool checkZoneType (ZonePtr z, uint32 type)
 
bool checkLinkedAnimBox (ZonePtr z, uint32 type, uint x, uint y)
 
ZonePtr hitZone (uint32 type, uint16 x, uint16 y)
 
void runZone (ZonePtr z)
 
bool pickupItem (ZonePtr z)
 
void updateDoor (ZonePtr z, bool close)
 
void showZone (ZonePtr z, bool visible)
 
void highlightInventoryItem (ItemPosition pos)
 
int16 getHoverInventoryItem (int16 x, int16 y)
 
int addInventoryItem (ItemName item)
 
int addInventoryItem (ItemName item, uint32 value)
 
void dropItem (uint16 v)
 
bool isItemInInventory (int32 v)
 
const InventoryItemgetInventoryItem (int16 pos)
 
int16 getInventoryItemIndex (int16 pos)
 
void cleanInventory (bool keepVerbs=true)
 
void openInventory ()
 
void closeInventory ()
 
virtual void parseLocation (const char *name)=0
 
virtual void changeLocation ()=0
 
virtual void changeCharacter (const char *name)=0
 
virtual void callFunction (uint index, void *parm)=0
 
virtual void runPendingZones ()=0
 
virtual void cleanupGame ()=0
 
virtual void updateWalkers ()=0
 
virtual void scheduleWalk (int16 x, int16 y, bool fromUser)=0
 
virtual DialogueManagercreateDialogueManager (ZonePtr z)=0
 
virtual bool processGameEvent (int event)=0
 
- 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 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...
 
virtual void initKeymap ()
 
virtual void deinitKeymap ()
 
virtual void flipMute ()
 Flip mute all sound option. More...
 
virtual Common::Error loadGameState (int slot)
 Load a game state. More...
 
void setGameToLoadSlot (int slot)
 Sets the game slot for a savegame to be loaded after global main menu execution. More...
 
virtual bool canLoadGameStateCurrently ()
 Indicates whether a game state can be loaded. More...
 
virtual Common::Error saveGameState (int slot, const Common::String &desc)
 Save a game state. More...
 
virtual bool canSaveGameStateCurrently ()
 Indicates whether a game state can be saved. More...
 

Public Attributes

int32 _screenWidth
 
int32 _screenHeight
 
int32 _screenSize
 
int _gameType
 
Gfx_gfx
 
Disk_disk
 
Input_input
 
Debugger_debugger
 
SaveLoad_saveLoad
 
MenuInputHelper_menuHelper
 
Common::RandomSource _rnd
 
SoundMan_soundMan
 
Font_labelFont
 
Font_menuFont
 
Font_introFont
 
Font_dialogueFont
 
Table_globalFlagsNames
 
Table_objectsNames
 
GfxObj_objects
 
Table_callableNames
 
Table_localFlagNames
 
CommandExec_cmdExec
 
ProgramExec_programExec
 
BalloonManager_balloonMan
 
DialogueManager_dialogueMan
 
InventoryRenderer_inventoryRenderer
 
Inventory_inventory
 
Character _char
 
uint32 _localFlags [NUM_LOCATIONS]
 
char _locationNames [NUM_LOCATIONS][32]
 
int16 _currentLocationIndex
 
uint16 _numLocations
 
Location _location
 
ZonePtr _activeZone
 
char _characterName1 [50]
 
ZonePtr _zoneTrap
 
ZonePtr _commentZone
 
Common::String _newLocationName
 
- Public Attributes inherited from Engine
OSystem_system
 
Audio::Mixer_mixer
 

Protected Member Functions

bool detectGame ()
 
void runGame ()
 
void runGameFrame (int event)
 
void runGuiFrame ()
 
void cleanupGui ()
 
void runDialogueFrame ()
 
void exitDialogueMode ()
 
void runCommentFrame ()
 
void enterCommentMode (ZonePtr z)
 
void exitCommentMode ()
 
void updateView ()
 
void drawAnimation (AnimationPtr anim)
 
void drawZone (ZonePtr zone)
 
void updateZones ()
 
void doLocationEnterTransition ()
 
void allocateLocationSlot (const char *name)
 
void finalizeLocationParsing ()
 
void showLocationComment (const Common::String &text, bool end)
 
void destroyDialogueManager ()
 
- Protected Member Functions inherited from Engine
virtual int runDialog (GUI::Dialog &dialog)
 
bool shouldPerformAutoSave (int lastSaveTime)
 Indicate whether an autosave should be performed. More...
 

Private Attributes

const PARALLACTIONGameDescription_gameDescription
 
uint16 _language
 

Friends

class Debugger
 

Additional Inherited Members

- 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...
 
- 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...
 
- Protected Attributes inherited from Engine
Common::TimerManager_timer
 
Common::EventManager_eventMan
 
Common::SaveFileManager_saveFileMan
 
GUI::Dialog_mainMenuDialog
 
const Common::String _targetName
 

Detailed Description

Definition at line 243 of file parallaction.h.

Constructor & Destructor Documentation

◆ Parallaction()

Parallaction::Parallaction::Parallaction ( OSystem syst,
const PARALLACTIONGameDescription gameDesc 
)

Definition at line 45 of file parallaction.cpp.

◆ ~Parallaction()

Parallaction::Parallaction::~Parallaction ( )

Definition at line 93 of file parallaction.cpp.

Member Function Documentation

◆ addInventoryItem() [1/2]

int Parallaction::Parallaction::addInventoryItem ( ItemName  item)

Definition at line 101 of file inventory.cpp.

◆ addInventoryItem() [2/2]

int Parallaction::Parallaction::addInventoryItem ( ItemName  item,
uint32  value 
)

Definition at line 105 of file inventory.cpp.

◆ allocateLocationSlot()

void Parallaction::Parallaction::allocateLocationSlot ( const char *  name)
protected

Definition at line 194 of file parallaction.cpp.

◆ beep()

void Parallaction::Parallaction::beep ( )

Definition at line 987 of file parallaction.cpp.

◆ callFunction()

virtual void Parallaction::Parallaction::callFunction ( uint  index,
void parm 
)
pure virtual

◆ changeCharacter()

virtual void Parallaction::Parallaction::changeCharacter ( const char *  name)
pure virtual

◆ changeLocation()

virtual void Parallaction::Parallaction::changeLocation ( )
pure virtual

◆ checkLinkedAnimBox()

bool Parallaction::Parallaction::checkLinkedAnimBox ( ZonePtr  z,
uint32  type,
uint  x,
uint  y 
)

Definition at line 749 of file parallaction.cpp.

◆ checkSpecialZoneBox()

bool Parallaction::Parallaction::checkSpecialZoneBox ( ZonePtr  z,
uint32  type,
uint  x,
uint  y 
)

Definition at line 653 of file parallaction.cpp.

◆ checkZoneBox()

bool Parallaction::Parallaction::checkZoneBox ( ZonePtr  z,
uint32  type,
uint  x,
uint  y 
)

Definition at line 718 of file parallaction.cpp.

◆ checkZoneType()

bool Parallaction::Parallaction::checkZoneType ( ZonePtr  z,
uint32  type 
)

Definition at line 691 of file parallaction.cpp.

◆ cleanInventory()

void Parallaction::Parallaction::cleanInventory ( bool  keepVerbs = true)

Definition at line 125 of file inventory.cpp.

◆ cleanupGame()

virtual void Parallaction::Parallaction::cleanupGame ( )
pure virtual

◆ cleanupGui()

void Parallaction::Parallaction::cleanupGui ( )
protected

Definition at line 74 of file gui.cpp.

◆ clearLocationFlags()

void Parallaction::Parallaction::clearLocationFlags ( uint32  flags)

Definition at line 384 of file parallaction.cpp.

◆ closeInventory()

void Parallaction::Parallaction::closeInventory ( )

Definition at line 133 of file inventory.cpp.

◆ createDialogueManager()

virtual DialogueManager* Parallaction::Parallaction::createDialogueManager ( ZonePtr  z)
pure virtual

◆ destroyDialogueManager()

void Parallaction::Parallaction::destroyDialogueManager ( )
protected

Definition at line 555 of file dialogue.cpp.

◆ detectGame()

bool Parallaction::Parallaction::detectGame ( )
protected

◆ doLocationEnterTransition()

void Parallaction::Parallaction::doLocationEnterTransition ( )
protected

Definition at line 343 of file parallaction.cpp.

◆ drawAnimation()

void Parallaction::Parallaction::drawAnimation ( AnimationPtr  anim)
protected

Definition at line 396 of file parallaction.cpp.

◆ drawZone()

void Parallaction::Parallaction::drawZone ( ZonePtr  zone)
protected

Definition at line 445 of file parallaction.cpp.

◆ dropItem()

void Parallaction::Parallaction::dropItem ( uint16  v)

Definition at line 109 of file inventory.cpp.

◆ enterCommentMode()

void Parallaction::Parallaction::enterCommentMode ( ZonePtr  z)
protected

Definition at line 510 of file parallaction.cpp.

◆ enterDialogueMode()

void Parallaction::Parallaction::enterDialogueMode ( ZonePtr  z)

Definition at line 522 of file dialogue.cpp.

◆ exitCommentMode()

void Parallaction::Parallaction::exitCommentMode ( )
protected

Definition at line 550 of file parallaction.cpp.

◆ exitDialogueMode()

void Parallaction::Parallaction::exitDialogueMode ( )
protected

Definition at line 534 of file dialogue.cpp.

◆ finalizeLocationParsing()

void Parallaction::Parallaction::finalizeLocationParsing ( )
protected

◆ getDebugger()

GUI::Debugger * Parallaction::Parallaction::getDebugger ( )
virtual

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 157 of file parallaction.cpp.

◆ getFeatures()

uint32 Parallaction::Parallaction::getFeatures ( ) const

Definition at line 42 of file detection.cpp.

◆ getGameType()

int Parallaction::Parallaction::getGameType ( ) const

Definition at line 41 of file detection.cpp.

◆ getHoverInventoryItem()

int16 Parallaction::Parallaction::getHoverInventoryItem ( int16  x,
int16  y 
)

Definition at line 83 of file inventory.cpp.

◆ getInternLanguage()

uint Parallaction::Parallaction::getInternLanguage ( )

Definition at line 86 of file gui.cpp.

◆ getInventoryItem()

const InventoryItem * Parallaction::Parallaction::getInventoryItem ( int16  pos)

Definition at line 117 of file inventory.cpp.

◆ getInventoryItemIndex()

int16 Parallaction::Parallaction::getInventoryItemIndex ( int16  pos)

Definition at line 121 of file inventory.cpp.

◆ getLanguage()

Common::Language Parallaction::Parallaction::getLanguage ( ) const

Definition at line 43 of file detection.cpp.

◆ getLocationFlags()

uint32 Parallaction::Parallaction::getLocationFlags ( )

Definition at line 392 of file parallaction.cpp.

◆ getPlatform()

Common::Platform Parallaction::Parallaction::getPlatform ( ) const

Definition at line 44 of file detection.cpp.

◆ go()

virtual Common::Error Parallaction::Parallaction::go ( )
pure virtual

◆ hasFeature()

bool Parallaction::Parallaction::hasFeature ( EngineFeature  f) const
virtual

Determine whether the engine supports the specified feature.

Reimplemented from Engine.

Definition at line 250 of file detection.cpp.

◆ highlightInventoryItem()

void Parallaction::Parallaction::highlightInventoryItem ( ItemPosition  pos)

Definition at line 87 of file inventory.cpp.

◆ hitZone()

ZonePtr Parallaction::Parallaction::hitZone ( uint32  type,
uint16  x,
uint16  y 
)

Definition at line 771 of file parallaction.cpp.

◆ init()

Common::Error Parallaction::Parallaction::init ( void  )
virtual

Reimplemented in Parallaction::Parallaction_br, and Parallaction::Parallaction_ns.

Definition at line 117 of file parallaction.cpp.

◆ isItemInInventory()

bool Parallaction::Parallaction::isItemInInventory ( int32  v)

Definition at line 113 of file inventory.cpp.

◆ openInventory()

void Parallaction::Parallaction::openInventory ( )

Definition at line 129 of file inventory.cpp.

◆ parseLocation()

virtual void Parallaction::Parallaction::parseLocation ( const char *  name)
pure virtual

◆ pauseEngineIntern()

void Parallaction::Parallaction::pauseEngineIntern ( bool  pause)
virtual

Actual implementation of pauseEngine by subclasses.

See there for details.

Reimplemented from Engine.

Definition at line 151 of file parallaction.cpp.

◆ pauseJobs()

void Parallaction::Parallaction::pauseJobs ( )

Definition at line 172 of file parallaction.cpp.

◆ pickupItem()

bool Parallaction::Parallaction::pickupItem ( ZonePtr  z)

Definition at line 640 of file parallaction.cpp.

◆ processGameEvent()

virtual bool Parallaction::Parallaction::processGameEvent ( int  event)
pure virtual

◆ resumeJobs()

void Parallaction::Parallaction::resumeJobs ( )

Definition at line 179 of file parallaction.cpp.

◆ run()

virtual Common::Error Parallaction::Parallaction::run ( )
inlinevirtual

Init the engine and start its main loop.

Returns
returns kNoError on success, else an error code.

Implements Engine.

Definition at line 266 of file parallaction.h.

◆ runCommentFrame()

void Parallaction::Parallaction::runCommentFrame ( )
protected

Definition at line 560 of file parallaction.cpp.

◆ runDialogueFrame()

void Parallaction::Parallaction::runDialogueFrame ( )
protected

Definition at line 561 of file dialogue.cpp.

◆ runGame()

void Parallaction::Parallaction::runGame ( )
protected

Definition at line 303 of file parallaction.cpp.

◆ runGameFrame()

void Parallaction::Parallaction::runGameFrame ( int  event)
protected

Definition at line 277 of file parallaction.cpp.

◆ runGuiFrame()

void Parallaction::Parallaction::runGuiFrame ( )
protected

Definition at line 56 of file gui.cpp.

◆ runPendingZones()

virtual void Parallaction::Parallaction::runPendingZones ( )
pure virtual

◆ runZone()

void Parallaction::Parallaction::runZone ( ZonePtr  z)

Definition at line 570 of file parallaction.cpp.

◆ scheduleLocationSwitch()

void Parallaction::Parallaction::scheduleLocationSwitch ( const char *  location)

Definition at line 996 of file parallaction.cpp.

◆ scheduleWalk()

virtual void Parallaction::Parallaction::scheduleWalk ( int16  x,
int16  y,
bool  fromUser 
)
pure virtual

◆ setInternLanguage()

void Parallaction::Parallaction::setInternLanguage ( uint  id)

Definition at line 79 of file gui.cpp.

◆ setLocationFlags()

void Parallaction::Parallaction::setLocationFlags ( uint32  flags)

Definition at line 380 of file parallaction.cpp.

◆ showLocationComment()

void Parallaction::Parallaction::showLocationComment ( const Common::String text,
bool  end 
)
protected

Definition at line 273 of file parallaction.cpp.

◆ showSlide()

void Parallaction::Parallaction::showSlide ( const char *  name,
int  x = 0,
int  y = 0 
)

Definition at line 263 of file parallaction.cpp.

◆ showZone()

void Parallaction::Parallaction::showZone ( ZonePtr  z,
bool  visible 
)

Definition at line 491 of file parallaction.cpp.

◆ toggleLocationFlags()

void Parallaction::Parallaction::toggleLocationFlags ( uint32  flags)

Definition at line 388 of file parallaction.cpp.

◆ updateDoor()

void Parallaction::Parallaction::updateDoor ( ZonePtr  z,
bool  close 
)

Definition at line 623 of file parallaction.cpp.

◆ updateView()

void Parallaction::Parallaction::updateView ( )
protected

Definition at line 161 of file parallaction.cpp.

◆ updateWalkers()

virtual void Parallaction::Parallaction::updateWalkers ( )
pure virtual

◆ updateZones()

void Parallaction::Parallaction::updateZones ( )
protected

Definition at line 467 of file parallaction.cpp.

Friends And Related Function Documentation

◆ Debugger

friend class Debugger
friend

Definition at line 244 of file parallaction.h.

Member Data Documentation

◆ _activeZone

ZonePtr Parallaction::Parallaction::_activeZone

Definition at line 320 of file parallaction.h.

◆ _balloonMan

BalloonManager* Parallaction::Parallaction::_balloonMan

Definition at line 308 of file parallaction.h.

◆ _callableNames

Table* Parallaction::Parallaction::_callableNames

Definition at line 304 of file parallaction.h.

◆ _char

Character Parallaction::Parallaction::_char

Definition at line 314 of file parallaction.h.

◆ _characterName1

char Parallaction::Parallaction::_characterName1[50]

Definition at line 321 of file parallaction.h.

◆ _cmdExec

CommandExec* Parallaction::Parallaction::_cmdExec

Definition at line 306 of file parallaction.h.

◆ _commentZone

ZonePtr Parallaction::Parallaction::_commentZone

Definition at line 323 of file parallaction.h.

◆ _currentLocationIndex

int16 Parallaction::Parallaction::_currentLocationIndex

Definition at line 317 of file parallaction.h.

◆ _debugger

Debugger* Parallaction::Parallaction::_debugger

Definition at line 288 of file parallaction.h.

◆ _dialogueFont

Font* Parallaction::Parallaction::_dialogueFont

Definition at line 298 of file parallaction.h.

◆ _dialogueMan

DialogueManager* Parallaction::Parallaction::_dialogueMan

Definition at line 309 of file parallaction.h.

◆ _disk

Disk* Parallaction::Parallaction::_disk

Definition at line 286 of file parallaction.h.

◆ _gameDescription

const PARALLACTIONGameDescription* Parallaction::Parallaction::_gameDescription
private

Definition at line 256 of file parallaction.h.

◆ _gameType

int Parallaction::Parallaction::_gameType

Definition at line 282 of file parallaction.h.

◆ _gfx

Gfx* Parallaction::Parallaction::_gfx

Definition at line 285 of file parallaction.h.

◆ _globalFlagsNames

Table* Parallaction::Parallaction::_globalFlagsNames

Definition at line 301 of file parallaction.h.

◆ _input

Input* Parallaction::Parallaction::_input

Definition at line 287 of file parallaction.h.

◆ _introFont

Font* Parallaction::Parallaction::_introFont

Definition at line 297 of file parallaction.h.

◆ _inventory

Inventory* Parallaction::Parallaction::_inventory

Definition at line 311 of file parallaction.h.

◆ _inventoryRenderer

InventoryRenderer* Parallaction::Parallaction::_inventoryRenderer

Definition at line 310 of file parallaction.h.

◆ _labelFont

Font* Parallaction::Parallaction::_labelFont

Definition at line 295 of file parallaction.h.

◆ _language

uint16 Parallaction::Parallaction::_language
private

Definition at line 257 of file parallaction.h.

◆ _localFlagNames

Table* Parallaction::Parallaction::_localFlagNames

Definition at line 305 of file parallaction.h.

◆ _localFlags

uint32 Parallaction::Parallaction::_localFlags[NUM_LOCATIONS]

Definition at line 315 of file parallaction.h.

◆ _location

Location Parallaction::Parallaction::_location

Definition at line 319 of file parallaction.h.

◆ _locationNames

char Parallaction::Parallaction::_locationNames[NUM_LOCATIONS][32]

Definition at line 316 of file parallaction.h.

◆ _menuFont

Font* Parallaction::Parallaction::_menuFont

Definition at line 296 of file parallaction.h.

◆ _menuHelper

MenuInputHelper* Parallaction::Parallaction::_menuHelper

Definition at line 290 of file parallaction.h.

◆ _newLocationName

Common::String Parallaction::Parallaction::_newLocationName

Definition at line 324 of file parallaction.h.

◆ _numLocations

uint16 Parallaction::Parallaction::_numLocations

Definition at line 318 of file parallaction.h.

◆ _objects

GfxObj* Parallaction::Parallaction::_objects

Definition at line 303 of file parallaction.h.

◆ _objectsNames

Table* Parallaction::Parallaction::_objectsNames

Definition at line 302 of file parallaction.h.

◆ _programExec

ProgramExec* Parallaction::Parallaction::_programExec

Definition at line 307 of file parallaction.h.

◆ _rnd

Common::RandomSource Parallaction::Parallaction::_rnd

Definition at line 291 of file parallaction.h.

◆ _saveLoad

SaveLoad* Parallaction::Parallaction::_saveLoad

Definition at line 289 of file parallaction.h.

◆ _screenHeight

int32 Parallaction::Parallaction::_screenHeight

Definition at line 280 of file parallaction.h.

◆ _screenSize

int32 Parallaction::Parallaction::_screenSize

Definition at line 281 of file parallaction.h.

◆ _screenWidth

int32 Parallaction::Parallaction::_screenWidth

Definition at line 279 of file parallaction.h.

◆ _soundMan

SoundMan* Parallaction::Parallaction::_soundMan

Definition at line 292 of file parallaction.h.

◆ _zoneTrap

ZonePtr Parallaction::Parallaction::_zoneTrap

Definition at line 322 of file parallaction.h.


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