engines/saga/xref.txt

   1 $Id$
   2
   3 Cross-reference for functions and variables for the original source code and
   4 the ScummVM implementation.
   5
   6 Watcom C++ arguments order:
   7
   8   eax, edx, ebx, ecx, stack
   9
  10 Sceneres.h
  11 ==========
  12  LOADREQ_FIGURE
  13  LOADREQ_OBJECT
  14  LOADREQ_BACKGROUND        SAGA_BG_IMAGE
  15  LOADREQ_ZBUF              SAGA_BG_MASK
  16  LOADREQ_SCENE_SCRIPT
  17  LOADREQ_STRINGS           SAGA_OBJECT_NAME_LIST
  18  LOADREQ_HITZONES          SAGA_OBJECT_MAP
  19  LOADREQ_STEPZONES         SAGA_ACTION_MAP
  20  LOADREQ_TILE_IMAGES       SAGA_ISO_TILESET
  21  LOADREQ_TILE_MAP          SAGA_ISO_METAMAP
  22  LOADREQ_TILE_PLATFORMS    SAGA_ISO_METATILESET
  23  LOADREQ_TILE_METATILES
  24  LOADREQ_ENTRY             SAGA_ENTRY
  25  LOADREQ_FRAMELIST
  26
  27  LOADREQ_ANIM_0            SAGA_ANIM_1
  28  LOADREQ_ANIM_1            SAGA_ANIM_2
  29  LOADREQ_ANIM_2            SAGA_ANIM_3
  30  LOADREQ_ANIM_3            SAGA_ANIM_4
  31  LOADREQ_ANIM_4            SAGA_ANIM_5
  32  LOADREQ_ANIM_5            SAGA_ANIM_6
  33  LOADREQ_ANIM_6            SAGA_ANIM_7
  34  LOADREQ_ANIM_7
  35
  36  LOADREQ_TILE_MULTI
  37  LOADREQ_CYCLES            SAGA_PAL_ANIM
  38  LOADREQ_FACES             SAGA_FACES
  39  LOADREQ_PALETTE
  40
  41  hitZone                   _objectMap
  42  stepZone                  _actionMap
  43
  44  HZONEF_EXIT               OBJECT_EXIT (in Verb.c), ACTION_EXIT (in Actor.c)
  45  HZONEF_ENABLED            OBJECT_ENABLED (in Verb.c), ACTION_ENABLED (in Actor.c)
  46  HZONEF_NOWALK             OBJECT_NOWALK
  47  HZONEF_PROJECT            OBJECT_PROJECT
  48  HZONEF_AUTOWALK           ACTION_AUTOWALK
  49  HZONEF_TERMINUS           ACTION_TERMINUS
  50
  51  FrameRange.startFrame     ACTORACTIONITEM.frame_index
  52  FrameRange.frameCount     ACTORACTIONITEM.frame_count
  53
  54  FrameSequence.right       ACTORACTION.dir[0]
  55  FrameSequence.left        ACTORACTION.dir[1]
  56  FrameSequence.back        ACTORACTION.dir[2]
  57  FrameSequence.forward     ACTORACTION.dir[3]
  58
  59 Scene.c
  60 =======
  61  ResToImage()              _vm->decodeBGImage()
  62  resInfo->sceneFlags       _desc.flags
  63  resInfo->loadList         _desc.resListRN
  64  resInfo->horizon          _desc.endSlope
  65  resInfo->nearFigureLimit  _desc.beginSlope
  66  resInfo->scriptModule     _desc.scriptModuleNumber
  67  resInfo->entryScript      _desc.sceneScriptEntrypointNumber
  68  resInfo->preScript        _desc.startScriptEntrypointNumber
  69  resInfo->backgroundMusic  _desc.musicRN
  70  thisScene->ID             currentSceneNumber()
  71
  72 Interp.c
  73 ========
  74  dispatchThreads()         executeThreads()
  75  runThread()               SThreadCompleteThread()
  76  moduleList                _scriptLUT
  77  ModuleEntry->codeID       _scriptLUT->script_rn
  78  ModuleEntry->strID        _scriptLUT->diag_list_rn
  79  ModuleEntry->vtableID     _scriptLUT->voice_lut_rn
  80  threadBase.theAction      threadVars[kVarAction]
  81  threadBase.theObject      threadVars[kVarObject]
  82  threadBase.withObject     threadVars[kVarWithObject]
  83  threadBase.theActor       threadVars[kVarActor]
  84
  85 Actor.h
  86 =======
  87  GOF_PROTAGONIST           kProtagonist
  88  GOF_FOLLOWER              kFollower
  89  GOF_CYCLE                 kCycle
  90  GOF_FASTER                kFaster
  91  GOF_FASTEST               kFastest
  92  GOF_EXTENDED              kExtended
  93
  94 Actor.c
  95 =======
  96  abortAllSpeeches()        abortAllSpeeches()
  97
  98 Main.c
  99 ======
 100  sceneIndexTable           _scene->getSceneLUT()
 101
 102 Main.h
 103 ======
 104 BRIGHT_WHITE               kITEColorBrightWhite
 105 WHITE_02                   kITEColorWhite
 106 GREY_0A                    kITEColorGrey
 107 DK_GREY_0B                 kITEColorDarkGrey
 108 PITCH_BLACK                kITEColorBlack
 109 RED_65                     kITEColorRed
 110 BLUE_93                    kITEColorBlue
 111 GREEB_BA                   kITEColorGreen
 112
 113 Note that ScummVM's kITEColorLightGrey does not have any corresponding
 114 constant in the original SAGA engine. We use it for the ITE mouse cursor. See
 115 PtrData[] in Main.c and setCursor() in gfx.cpp
 116
 117 Tile.h
 118 ======
 119  isoTile.height            ISOTILE_ENTRY.tile_h
 120  isoTile.attributes        ISOTILE_ENTRY.mask_rule
 121  isoTile.offset            ISOTILE_ENTRY.tile_offset
 122  isoTile.terrain_mask      ISOTILE_ENTRY.terrain_mask
 123  isoTile.fgd_bgd_attr      ISOTILE_ENTRY.mask
 124
 125  tilePlatform.metaTile     ISO_METATILE_ENTRY.mtile_n
 126  tilePlatform.height       ISO_METATILE_ENTRY.height
 127  tilePlatform.highestPixel ISO_METATILE_ENTRY.highest_pixel
 128  tilePlatform.vBits        ISO_METATILE_ENTRY.v_bits
 129  tilePlatform.uBits        ISO_METATILE_ENTRY.u_bits
 130
 131 Resource.h
 132 ==========
 133  PicHeader.width           IMAGE_HEADER.width
 134  PicHeader.height          IMAGE_HEADER.height
 135
 136
 137 Process.c
 138 =========
 139  mainPanelMode             Interface::_inMainMode