ScummVM API documentation
opcode.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef OPCODE_H
23#define OPCODE_H
24
25#include "common/scummsys.h"
26
27namespace AGDS {
28
29enum Opcode : uint16 {
30 kEnter = 5,
31 kJumpZImm16 = 8,
32 kJumpImm16 = 9,
33 kPop = 10,
34 kDup = 11,
35 kExitProcess = 12,
36 kSuspendProcess = 13,
37 kPushImm32 = 14,
38 kPushImm16 = 15,
39 kPushImm8 = 16,
40 kPushImm16_2 = 17,
41 kPushImm8_2 = 18,
42 kStub19 = 19,
43 kStub20 = 20,
44 kGetGlobalImm8 = 21,
45 kEquals = 22,
46 kNotEquals = 23,
47 kGreater = 24,
48 kLess = 25,
49 kGreaterOrEquals = 26,
50 kLessOrEquals = 27,
51 kAdd = 28,
52 kSub = 29,
53 kMul = 30,
54 kDiv = 31,
55 kMod = 32,
56 kAnd = 33,
57 kOr = 34,
58 kXor = 35,
59 kNot = 36,
60 kShl = 37,
61 kShr = 38,
62 kBoolAnd = 39,
63 kBoolOr = 40,
64 kBoolNot = 41,
65 kNegate = 42,
66 kPreIncrementGlobal = 43,
67 kPreDecrementGlobal = 44,
68 kPostIncrementGlobal = 45,
69 kPostDecrementGlobal = 46,
70 kSetGlobalWithTop = 47,
71 kSetGlobal = 48,
72 kIncrementGlobalByTop = 49,
73 kDecrementGlobalByTop = 50,
74 kMultiplyGlobalByTop = 51,
75 kDivideGlobalByTop = 52,
76 kModGlobalByTop = 53,
77 kShlGlobalByTop = 54,
78 kShrGlobalByTop = 55,
79 kAndGlobalByTop = 56,
80 kOrGlobalByTop = 57,
81 kXorGlobalByTop = 58,
82 kObjectInitialise = 59,
83 kObjectRegisterLookHandler = 60,
84 kObjectRegisterUseHandler = 61,
85 kObjectRegisterHandlerC1 = 62,
86 kObjectRegisterUseObjectHandler = 63,
87 kObjectRegisterHandlerBD = 64,
88 kObjectRegisterCharacterTrap = 65,
89 kLoadMouseCursorFromObject = 66,
90 kLoadRegionFromObject = 68,
91 kLoadPictureFromObject = 69,
92 kLoadAnimationFromObject = 70,
93 kSetObjectZ = 71,
94 kSetScreenBackground = 72,
95 kLoadTextFromObject = 73,
96 kScreenSetZNearFar = 74,
97 kScreenLoadRegion = 75,
98 kScreenLoadObject = 76,
99 kScreenCloneObject = 77,
100 kScreenRemoveObject = 78,
101 kSetNextScreen = 79,
102 kSetNextScreenSaveOrLoad = 80,
103 kObjectPatchSetText = 82,
104 kObjectPatchSetRegionName = 83,
105 kScreenPatchSetRegionName = 84,
106 kLoadCharacter = 85,
107 kUnloadCharacter = 86,
108 kAssociateCharacter = 87,
109 kAnimateCharacter = 88,
110 kHideCharacter = 89,
111 kShowCharacter = 90,
112 kDisableCharacter = 91,
113 kEnableCharacter = 92,
114 kMoveCharacterUserMove = 93,
115 kLeaveCharacter = 94,
116 kSetCharacter = 95,
117 kSetCharacterDirection = 96,
118 kPointCharacter = 97,
119 kDisableUser = 98,
120 kEnableUser = 99,
121 kRestartSample = 100,
122 kStopSample = 101,
123 kStub102 = 102,
124 kStub103 = 103,
125 kStub104 = 104,
126 kClearScreen = 105,
127 kInventoryClear = 106,
128 kStub107 = 107,
129 kLoadMouse = 108,
130 kAttachInventoryObjectToMouse0 = 109,
131 kResetMousePointer = 110,
132 kInventoryAddObject = 111,
133 kInventoryRemoveObject = 112,
134 kStub113 = 113,
135 kStub114 = 114,
136 kStub115 = 115,
137 kStub116 = 116,
138 kLoadAnimation = 117,
139 kLoadSample = 118,
140 kSetPhaseVarControlledFlag = 119,
141 kPlayerSay120 = 120,
142 kStub121 = 121,
143 kPlayerSay122 = 122,
144 kNPCSayNoSound = 123,
145 kNPCSay = 124,
146 kPlayerSay125 = 125,
147 kStub126 = 126,
148 kSetTimer = 127,
149 kProcessResetState = 128,
150 kSetAnimationZ = 129,
151 kSetCycles = 130,
152 kSetRandom = 131,
153 kSetPeriodic = 132,
154 kSetPanAndVolume = 133,
155 kSetAnimationPosition = 134,
156 kSetPhaseVar = 135,
157 kSetAnimationLoop = 136,
158 kSetAnimationSpeed = 137,
159 kScreenObjectPatchIncRef = 138,
160 kScreenObjectPatchDecRef = 139,
161 kScreenCheckScreenPatch = 140,
162 kGetFreeInventorySpace = 141,
163 kSetStringSystemVariable = 142,
164 kSetSystemIntegerVariable = 143,
165 kGetSavedMouseX = 144,
166 kGetSavedMouseY = 145,
167 kGetRegionCenterX = 146,
168 kGetRegionCenterY = 147,
169 kGetCharacterAnimationPhase = 148,
170 kGetCharacterX = 149,
171 kGetCharacterY = 150,
172 kCompareScreenName = 151,
173 kGetPictureBaseX = 152,
174 kGetPictureBaseY = 153,
175 kGetObjectSurfaceX = 154,
176 kGetObjectSurfaceY = 155,
177 kLoadGame = 156,
178 kSaveGame = 157,
179 kQuit = 158,
180 kStartNewGame = 159,
181 kLoadSaveSlotNamePicture = 160,
182 kGetSaveGameName = 161,
183 kDisableInventory = 162,
184 kEnableInventory = 163,
185 kLoadPreviousScreen = 164,
186 kMoveScreenObject = 165,
187 kSetObjectRegionOffset = 166,
188 kReturnCurrentInventoryObject = 167,
189 kStub168 = 168,
190 kGetIntegerSystemVariable = 169,
191 kSetDelay = 170,
192 kGetRandomNumber = 171,
193 kSetSampleVolume = 172,
194 kStub173 = 173,
195 kStub174 = 174,
196 kAppendToSharedStorage = 175,
197 kCloneName = 176,
198 kAppendNameToSharedStorage = 177,
199 kGetCloneVar = 178,
200 kSetCloneVar = 179,
201 kGetObjectId = 180,
202 kStub181 = 181,
203 kSetTileSize = 182,
204 kGenerateRegion = 183,
205 kSetObjectTile = 184,
206 kGetMaxInventorySize = 185,
207 kInventoryHasObject = 186,
208 kAppendInventoryObjectNameToSharedSpace = 187,
209 kSetObjectText = 188,
210 kInventoryFindObjectByName = 189,
211 kSetObjectScale = 190,
212 kDisableMouseAreas = 191,
213 kObjectIgnoreRegion = 192,
214 kRemoveGapsFromInventory = 193,
215 kSampleAmbient = 194,
216 kGetObjectPictureWidth = 195,
217 kGetObjectPictureHeight = 196,
218 kSetRotation = 197,
219 kLoadPicture = 198,
220 kStub199 = 199,
221 kSetTileIndex = 200,
222 kSetThrowHandler = 201,
223 kSetUseOnHandler = 202,
224 kPlayFilm = 203,
225 kStub204 = 204,
226 kAddMouseArea = 205,
227 kModifyMouseArea = 206,
228 kSetRain = 207,
229 kFogOnCharacter = 208,
230 kObjectRegisterUserUseHandler = 209,
231 kStub210 = 210,
232 kStub211 = 211,
233 kSetSampleVolumeAndPan = 212,
234 kStub213 = 213,
235 kAddSampleToSoundGroup = 214,
236 kClearSoundGroup = 215,
237 kStub216 = 216,
238 kStub217 = 217,
239 kSetRainDensity = 218,
240 kLeaveCharacterEx = 219,
241 kStopCharacter = 220,
242 kRestartAnimation = 221,
243 kSignalAnimationEnd = 222,
244 kSetShadowIntensity = 223,
245 kSetNPCTellNotifyVar = 224,
246 kPauseAnimation = 225,
247 kFadeObject = 226,
248 kLoadFont = 227,
249 kMoveCharacterNoUserMove = 228,
250 kOnKey = 229,
251 kStub230 = 230,
252 kStub231 = 231,
253 kStub232 = 232,
254 kObjectFreePictureAndAnimation = 233,
255 kGetSampleVolume = 234,
256 kFadeScreen = 235,
257 kUserEnabled = 236,
258 kAnimationNextFrame = 237,
259 kInventoryHasObjectByName = 238,
260 kStub239 = 239,
261 kLoadDialog = 240,
262 kStub241 = 241,
263 kHasGlobal = 242,
264 kStub243 = 243,
265 kSetCharacterNotifyVars = 244,
266 kAttachInventoryObjectToMouse1 = 245,
267 kStub246 = 246,
268 kSetDialogForNextFilm = 247,
269 kSetCamera = 252,
270 kStub251 = 251,
271 kCharacterStub253 = 253,
272 kStub257 = 257,
273 kStub258 = 258,
274 kSetFog = 263,
275 kStub264 = 264,
276 kStub265 = 265,
277 kStub266 = 266,
278 kStub267 = 267,
279 kStub275 = 275,
280 kStub276 = 276,
281 kStub278 = 278,
282 kStub279 = 279,
283 kStub280 = 280,
284 kStub284 = 284,
285 kStub291 = 291,
286 kStub292 = 292,
287};
288
289#define AGDS_OPCODE_LIST(OP, OP_C, OP_B, OP_W, OP_U, OP_UD, OP_UU) \
290 OP_UU(kEnter, enter) \
291 OP_W(kJumpZImm16, jumpz) \
292 OP_W(kJumpImm16, jump) \
293 OP(kPop, popNoResult) \
294 OP(kDup, dup) \
295 OP(kExitProcess, exitProcess) \
296 OP(kSuspendProcess, suspend) \
297 OP_UD(kPushImm32, push) \
298 OP_C(kPushImm8, push) \
299 OP_W(kPushImm16, push) \
300 OP_C(kPushImm8_2, push2) \
301 OP_W(kPushImm16_2, push2) \
302 OP_B(kGetGlobalImm8, getGlobal) \
303 OP(kPostIncrementGlobal, postIncrementGlobal) \
304 OP(kPostDecrementGlobal, postDecrementGlobal) \
305 OP(kIncrementGlobalByTop, incrementGlobalByTop) \
306 OP(kDecrementGlobalByTop, decrementGlobalByTop) \
307 OP(kMultiplyGlobalByTop, multiplyGlobalByTop) \
308 OP(kDivideGlobalByTop, divideGlobalByTop) \
309 OP(kModGlobalByTop, modGlobalByTop) \
310 OP(kShlGlobalByTop, shlGlobalByTop) \
311 OP(kShrGlobalByTop, shrGlobalByTop) \
312 OP(kAndGlobalByTop, andGlobalByTop) \
313 OP(kOrGlobalByTop, orGlobalByTop) \
314 OP(kXorGlobalByTop, xorGlobalByTop) \
315 OP(kEquals, equals) \
316 OP(kNotEquals, notEquals) \
317 OP(kGreater, greater) \
318 OP(kLess, less) \
319 OP(kGreaterOrEquals, greaterOrEquals) \
320 OP(kLessOrEquals, lessOrEquals) \
321 OP(kAdd, add) \
322 OP(kSub, sub) \
323 OP(kMul, mul) \
324 OP(kDiv, div) \
325 OP(kMod, mod) \
326 OP(kSetGlobalWithTop, setGlobalWithTop) \
327 OP(kSetGlobal, setGlobal) \
328 OP(kBoolOr, boolOr) \
329 OP(kBoolAnd, boolAnd) \
330 OP(kAnd, bitAnd) \
331 OP(kOr, bitOr) \
332 OP(kXor, bitXor) \
333 OP(kNot, bitNot) \
334 OP(kShl, shl) \
335 OP(kShr, shr) \
336 OP(kBoolNot, boolNot) \
337 OP(kNegate, negate) \
338 OP_U(kObjectInitialise, initialise) \
339 OP_U(kObjectRegisterLookHandler, onLook) \
340 OP_U(kObjectRegisterUseHandler, onUse) \
341 OP_U(kObjectRegisterHandlerC1, onObjectC1) \
342 OP_U(kObjectRegisterCharacterTrap, onCharacterTrap) \
343 OP_U(kObjectRegisterHandlerBD, onObjectBD) \
344 OP(kLoadMouseCursorFromObject, loadMouseCursorFromObject) \
345 OP(kLoadRegionFromObject, loadRegionFromObject) \
346 OP(kLoadPictureFromObject, loadPictureFromObject) \
347 OP(kLoadAnimationFromObject, loadAnimationFromObject) \
348 OP(kHideCharacter, hideCharacter) \
349 OP(kShowCharacter, showCharacter) \
350 OP(kEnableCharacter, enableCharacter) \
351 OP(kMoveCharacterUserMove, moveCharacterUserMove) \
352 OP(kLeaveCharacter, leaveCharacter) \
353 OP(kSetCharacter, setCharacter) \
354 OP(kSetCharacterDirection, setCharacterDirection) \
355 OP(kPointCharacter, pointCharacter) \
356 OP(kDisableUser, disableUser) \
357 OP(kEnableUser, enableUser) \
358 OP(kRestartSample, restartSample) \
359 OP(kStopSample, stopSample) \
360 OP(kStub102, stub102) \
361 OP(kClearScreen, clearScreen) \
362 OP(kInventoryClear, inventoryClear) \
363 OP(kLoadMouse, loadMouse) \
364 OP(kResetMousePointer, resetMousePointer) \
365 OP(kInventoryAddObject, inventoryAddObject) \
366 OP(kInventoryRemoveObject, inventoryRemoveObject) \
367 OP_U(kObjectRegisterUseObjectHandler, onObjectUse) \
368 OP(kObjectPatchSetText, objectPatchSetText) \
369 OP(kObjectPatchSetRegionName, objectPatchSetRegionName) \
370 OP(kScreenPatchSetRegionName, screenPatchSetRegionName) \
371 OP(kAnimateCharacter, animateCharacter) \
372 OP(kLoadCharacter, loadCharacter) \
373 OP(kAssociateCharacter, associateCharacter) \
374 OP(kSetObjectZ, setObjectZ) \
375 OP(kSetScreenBackground, setScreenBackground) \
376 OP(kLoadTextFromObject, loadTextFromObject) \
377 OP(kCompareScreenName, compareScreenName) \
378 OP(kScreenSetZNearFar, screenSetZNearFar) \
379 OP(kScreenLoadObject, loadScreenObject) \
380 OP(kScreenLoadRegion, loadScreenRegion) \
381 OP(kScreenCloneObject, cloneObject) \
382 OP(kSetNextScreen, setNextScreen) \
383 OP(kSetNextScreenSaveOrLoad, setNextScreenSaveOrLoad) \
384 OP(kScreenRemoveObject, removeScreenObject) \
385 OP(kLoadAnimation, loadAnimation) \
386 OP(kLoadSample, loadSample) \
387 OP(kSetPhaseVarControlledFlag, setPhaseVarControlledFlag) \
388 OP(kPlayerSay120, playerSay120) \
389 OP(kPlayerSay122, playerSay122) \
390 OP(kPlayerSay125, playerSay125) \
391 OP(kNPCSay, npcSay) \
392 OP(kNPCSayNoSound, npcSayNoSound) \
393 OP(kSetTimer, setTimer) \
394 OP(kProcessResetState, resetState) \
395 OP(kSetAnimationZ, setAnimationZ) \
396 OP(kSetCycles, setCycles) \
397 OP(kSetRandom, setRandom) \
398 OP(kSetPeriodic, setPeriodic) \
399 OP(kSetPanAndVolume, setPanAndVolume) \
400 OP(kSetAnimationPosition, setAnimationPosition) \
401 OP(kSetPhaseVar, setPhaseVar) \
402 OP(kSetAnimationLoop, setAnimationLoop) \
403 OP(kSetAnimationSpeed, setAnimationSpeed) \
404 OP(kScreenObjectPatchIncRef, screenObjectPatchIncRef) \
405 OP(kScreenObjectPatchDecRef, screenObjectPatchDecRef) \
406 OP(kGetSavedMouseX, getSavedMouseX) \
407 OP(kGetSavedMouseY, getSavedMouseY) \
408 OP(kScreenCheckScreenPatch, checkScreenPatch) \
409 OP(kGetFreeInventorySpace, getInventoryFreeSpace) \
410 OP(kSetStringSystemVariable, setStringSystemVariable) \
411 OP(kSetSystemIntegerVariable, setIntegerSystemVariable) \
412 OP(kGetRegionCenterX, getRegionCenterX) \
413 OP(kGetRegionCenterY, getRegionCenterY) \
414 OP(kGetCharacterAnimationPhase, getCharacterAnimationPhase) \
415 OP(kGetCharacterX, getCharacterX) \
416 OP(kGetCharacterY, getCharacterY) \
417 OP(kGetIntegerSystemVariable, getIntegerSystemVariable) \
418 OP(kGetRandomNumber, getRandomNumber) \
419 OP(kAppendToSharedStorage, appendToSharedStorage) \
420 OP(kAppendNameToSharedStorage, appendNameToSharedStorage) \
421 OP(kCloneName, cloneName) \
422 OP(kGetCloneVar, getCloneVar) \
423 OP(kSetCloneVar, setCloneVar) \
424 OP(kGetPictureBaseX, getPictureBaseX) \
425 OP(kGetPictureBaseY, getPictureBaseY) \
426 OP(kGetObjectSurfaceX, getObjectSurfaceX) \
427 OP(kGetObjectSurfaceY, getObjectSurfaceY) \
428 OP(kLoadGame, loadGame) \
429 OP(kSaveGame, saveGame) \
430 OP(kLoadSaveSlotNamePicture, loadSaveSlotNamePicture) \
431 OP(kGetSaveGameName, getSaveGameName) \
432 OP(kSetObjectRegionOffset, setObjectRegionOffset) \
433 OP(kSetDelay, setDelay) \
434 OP(kSetSampleVolume, setSampleVolume) \
435 OP(kStub173, stub173) \
436 OP(kStub174, stub174) \
437 OP(kObjectIgnoreRegion, objectIgnoreRegion) \
438 OP(kQuit, quit) \
439 OP(kStartNewGame, startNewGame) \
440 OP(kDisableInventory, disableInventory) \
441 OP(kEnableInventory, enableInventory) \
442 OP(kLoadPreviousScreen, loadPreviousScreen) \
443 OP(kMoveScreenObject, moveScreenObject) \
444 OP(kGetObjectId, getObjectId) \
445 OP(kSetTileSize, setTileSize) \
446 OP(kGenerateRegion, generateRegion) \
447 OP(kGetMaxInventorySize, getMaxInventorySize) \
448 OP(kAppendInventoryObjectNameToSharedSpace, appendInventoryObjectNameToSharedSpace) \
449 OP(kSetObjectTile, setObjectTile) \
450 OP(kInventoryHasObject, inventoryHasObject) \
451 OP(kReturnCurrentInventoryObject, returnCurrentInventoryObject) \
452 OP(kSetObjectText, setObjectText) \
453 OP(kSetObjectScale, setObjectScale) \
454 OP(kDisableMouseAreas, disableMouseAreas) \
455 OP(kRemoveGapsFromInventory, removeGapsFromInventory) \
456 OP(kSampleAmbient, sampleAmbient) \
457 OP(kGetObjectPictureWidth, getObjectPictureWidth) \
458 OP(kGetObjectPictureHeight, getObjectPictureHeight) \
459 OP(kLoadPicture, loadPicture) \
460 OP(kSetRotation, setRotation) \
461 OP(kStub199, stub199) \
462 OP(kSetSampleVolumeAndPan, setSampleVolumeAndPan) \
463 OP(kAddSampleToSoundGroup, addSampleToSoundGroup) \
464 OP(kClearSoundGroup, clearSoundGroup) \
465 OP(kStub216, stub216) \
466 OP(kStub217, stub217) \
467 OP(kStopCharacter, stopCharacter) \
468 OP(kLeaveCharacterEx, leaveCharacterEx) \
469 OP(kRestartAnimation, restartAnimation) \
470 OP(kAnimationNextFrame, animationNextFrame) \
471 OP(kSignalAnimationEnd, signalAnimationEnd) \
472 OP(kSetShadowIntensity, setShadowIntensity) \
473 OP(kSetNPCTellNotifyVar, setNPCTellNotifyVar) \
474 OP(kPauseAnimation, pauseAnimation) \
475 OP(kFadeObject, fadeObject) \
476 OP(kLoadFont, loadFont) \
477 OP_U(kSetThrowHandler, setThrowHandler) \
478 OP_U(kSetUseOnHandler, setUseOnHandler) \
479 OP(kPlayFilm, playFilm) \
480 OP(kAddMouseArea, addMouseArea) \
481 OP(kSetRain, setRain) \
482 OP(kSetRainDensity, setRainDensity) \
483 OP(kFogOnCharacter, fogOnCharacter) \
484 OP(kSetTileIndex, setTileIndex) \
485 OP(kModifyMouseArea, modifyMouseArea) \
486 OP_U(kObjectRegisterUserUseHandler, onObjectUserUse) \
487 OP(kMoveCharacterNoUserMove, moveCharacterNoUserMove) \
488 OP_U(kOnKey, onKey) \
489 OP(kGetSampleVolume, getSampleVolume) \
490 OP(kStub231, stub231) \
491 OP(kObjectFreePictureAndAnimation, objectFreePictureAndAnimation) \
492 OP(kFadeScreen, fadeScreen) \
493 OP(kUserEnabled, userEnabled) \
494 OP(kSetCharacterNotifyVars, setCharacterNotifyVars) \
495 OP(kInventoryFindObjectByName, inventoryFindObjectByName) \
496 OP(kInventoryHasObjectByName, inventoryHasObjectByName) \
497 OP(kLoadDialog, loadDialog) \
498 OP(kStub241, stub241) \
499 OP(kHasGlobal, hasGlobal) \
500 OP(kAttachInventoryObjectToMouse0, attachInventoryObjectToMouse0) \
501 OP(kAttachInventoryObjectToMouse1, attachInventoryObjectToMouse1) \
502 OP(kSetDialogForNextFilm, setDialogForNextFilm) \
503 OP(kCharacterStub253, characterStub253) \
504 OP(kStub251, stub251) \
505 OP(kStub257, stub257) \
506 OP(kStub258, stub258) \
507 OP(kStub264, stub264) \
508 OP(kStub265, stub265) \
509 OP(kStub266, stub266) \
510 OP(kStub267, stub267) \
511 OP(kStub275, stub275) \
512 OP(kStub276, stub276) \
513 OP(kSetCamera, setCamera) \
514 OP(kSetFog, setFog) \
515 OP(kStub278, stub278) \
516 OP(kStub279, stub279) \
517 OP(kStub280, stub280) \
518 OP(kStub284, stub284) \
519 OP(kStub291, stub291) \
520 OP(kStub292, stub292)
521
522} // namespace AGDS
523
524#endif