scummvm/engines/dragons/specialopcodes.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef DRAGONS_SPECIALOPCODES_H
#define DRAGONS_SPECIALOPCODES_H

#include "common/func.h"
#include "common/str.h"


namespace Dragons {

#define DRAGONS_NUM_SPECIAL_OPCODES 0x8c

class DragonsEngine;

typedef Common::Functor0<void> SpecialOpcode;

class SpecialOpcodes {
public:
	SpecialOpcodes(DragonsEngine *vm);
	~SpecialOpcodes();
	void run(int16 opcode);

	struct SceneUpdater {
		void *tbl;
		uint16 counter;
		int16 iniID;
		int16 sequenceID;
		uint32 curSequence;
		uint32 curSequenceIndex;
		uint32 numTotalSequences;
		uint32 sequenceDuration;
		uint16 numSteps[8];
		uint16 iniIDTbl[8][5];
		uint16 sequenceIDTbl[8][5];
		uint32 textTbl[8][5];

		SceneUpdater() {
			tbl = nullptr;
			iniID = sequenceID = 0;
			counter = 0;
			curSequence = curSequenceIndex = numTotalSequences = sequenceDuration = 0;

			for (uint i = 0; i < 8; i++) {
				numSteps[i] = 0;
				for (int j = 0; j < 5; j++) {
					iniIDTbl[i][j] = 0;
					sequenceIDTbl[i][j] = 0;
					textTbl[i][j] = 0;
				}
			}
		}
	} sceneUpdater;

protected:
	DragonsEngine *_vm;
	SpecialOpcode *_opcodes[DRAGONS_NUM_SPECIAL_OPCODES];
	Common::String _opcodeNames[DRAGONS_NUM_SPECIAL_OPCODES];
	int16 _specialOpCounter;
	uint8 _dat_80083148;
	uint16 _uint16_t_80083154;

public:
	int16 getSpecialOpCounter();
	void setSpecialOpCounter(int16 newValue);

protected:
	void initOpcodes();
	void freeOpcodes();

	// Opcodes
	void spcCatapultMiniGame(); // 1
	void spcThumbWrestlingMiniGame(); // 2
	void spcClearEngineFlag10(); // 3
	void spcSetEngineFlag10();   // 4

	void spcRabbitsMiniGame(); //6
	void spcDancingMiniGame(); // 7
	void spcCastleGardenLogic(); // 8
	void spcUnk9();
	void spcUnkA();

	void spcUnkC();
	void spcFadeScreen(); // 0xd
	void spcLadyOfTheLakeCapturedSceneLogic(); // 0xe, 0xf
	void spcStopLadyOfTheLakeCapturedSceneLogic(); // 0x10
	void spc11ShakeScreen(); //0x11
	void spcHandleInventionBookTransition(); // 0x12
	void spcUnk13InventionBookCloseRelated(); //0x13
	void spcClearEngineFlag8(); // 0x14
	void spcSetEngineFlag8(); // 0x15

	void spcKnightPoolReflectionLogic(); //0x17

	void spcWalkOnStilts(); //0x19
	void spcActivatePizzaMakerActor(); // 0x1a
	void spcDeactivatePizzaMakerActor(); // 0x1b
	void spcPizzaMakerActorStopWorking(); // 0x1c
	void spcDragonArrivesAtTournament(); // 0x1d
	void spcDragonCatapultMiniGame(); // 0x1e
	void spcStGeorgeDragonLanded(); // 0x1f

	void spcSetEngineFlag0x20000(); // 0x21
	void spcClearEngineFlag0x20000(); // 0x22
	void spcSetEngineFlag0x200000(); // 0x23
	void spcClearEngineFlag0x200000(); // 0x24
	void spcFlickerSetPriority2(); // 0x25
	void spcMenInMinesSceneLogic(); //0x26
	void spcStopMenInMinesSceneLogic(); //0x27
	void spcMonksAtBarSceneLogic(); //0x28
	void spcStopMonksAtBarSceneLogic(); //0x29

	void spcFlameBedroomEscapeSceneLogic(); // 0x2b
	void spcStopFlameBedroomEscapeSceneLogic(); // 0x2c

	void spcCastleMoatFull(); //0x2e
	void spcCastleRestoreScalePoints(); //0x2f
	void spcCastleMoatUpdateActorSceneScalePoints(); //0x30
	void spcCastleGateMoatDrainedSceneLogic(); //0x31

	void spcUnk34(); //0x34 pitchfork mole.

	void spcFlickerClearFlag0x80(); //0x36

	void spcNoop1(); // 0x38
	void spcTownAngryVillagersSceneLogic(); //0x39
	void spcBlackDragonCrashThroughGate(); //0x3a
	void spcSetEngineFlag0x2000000(); // 0x3b
	void spcClearEngineFlag0x2000000(); // 0x3c

	void spcZigmondFraudSceneLogic(); // 0x3e

	void spcZigmondFraudSceneLogic1(); // 0x40
	void spcBrokenBlackDragonSceneLogic(); // 0x41
	void spcDodoUnderAttackSceneLogic(); //0x42
	void spcForestWithoutDodoSceneLogic(); //0x43

	void spcBlackDragonOnHillSceneLogic(); //0x46

	void spcHedgehogTest(); // 0x48
	void spcLoadScene1(); // 0x49

	void spcKnightsSavedCastleCutScene(); //0x4b
	void spcFlickerReturnsCutScene(); // 0x4c
	void spcKnightsSavedAgainCutScene(); //0c4d
	void spcUnk4e();
	void spcUnk4f();
	void spcCloseInventory(); // 0x50
	void spcOpenInventionBook(); // 0x51
	void spcCloseInventionBook(); // 0x52
	void spcClearEngineFlag0x4000000(); // 0x53
	void spcSetEngineFlag0x4000000(); // 0x54
	void spcSetCursorSequenceIdToZero(); // 0x55

	void spcFlickerSetFlag0x80(); // 0x5b

	void spcUnk5d();
	void spcUnk5e();
	void spcUnk5f();

	void spcCastleBuildBlackDragonSceneLogic(); //0x61
	void spcStopSceneUpdateFunction(); //0x62
	void spcSetInventorySequenceTo5(); // 0x63
	void spcResetInventorySequence(); // 0x64
	void spcUnk65ScenePaletteRelated(); // 0x65;
	void spcUnk66();
	void spcTournamentSetCamera(); // 0x67
	void spcTournamentCutScene(); // 0x68
	void spcInsideBlackDragonUpdatePalette(); // 0x69
	void spcCastleGateSceneLogic(); // 0x6a
	void spcTransitionToMap(); // 0x6b
	void spcTransitionFromMap(); // 0x6c
	void spcCaveOfDilemmaSceneLogic(); // 0x6d

	void spcLoadLadyOfTheLakeActor(); //0x70
	void spcFadeCreditsToBackStageScene(); //0x71
	void spcRunCredits(); //0x72
	void spcEndCreditsAndRestartGame(); //0x73
	void spcUseClickerOnLever(); // 0x74

	void spcJesterInLibrarySceneLogic(); // 0x77

	void spcBlackDragonDialogForCamelhot(); // 0x7a
	void spcSetCameraXToZero(); //0x7b
	void spcDiamondIntroSequenceLogic(); //0x7c
	void spcLoadFileS10a6act(); //0x7d
	void spcLoadFileS10a7act(); //0x7e
	void spcFlickerPutOnStGeorgeArmor(); //0x7f
	void spcUnk80FlickerArmorOn(); //0x80
	void spcShakeScreenSceneLogic(); //0x81
	void spcClearTextFromScreen(); // 0x82
	void spcStopScreenShakeUpdater(); // 0x83
	void spcInsideBlackDragonScreenShake(); // 0x84
	void spc85SetScene1To0x35(); //0x85
	void spc86SetScene1To0x33(); //0x86
	void spc87SetScene1To0x17(); //0x87
	void spc88SetScene1To0x16(); //0x88
	void spcSetUnkFlag2(); // 0x89
	void spcClearUnkFlag2(); //0x8a
	void spcUnk8b(); //0x8b

	void setupTableBasedSceneUpdateFunction(uint16 initialCounter, uint16 numSequences, uint16 sequenceDuration);
private:
	void panCamera(int16 mode);
	void pizzaMakerStopWorking();

	void clearSceneUpdateFunction();
	void mapTransition(uint16 mode);

};

// update functions

void castleFogUpdateFunction();
void menInMinesSceneUpdateFunction();
void monksAtBarSceneUpdateFunction();
void flameEscapeSceneUpdateFunction();
void pizzaUpdateFunction();
void tableBasedSceneUpdateFunction();
void castleBuildingBlackDragon2UpdateFunction();
void shakeScreenUpdateFunction();
void ladyOfTheLakeCapturedUpdateFunction();
void caveOfDilemmaUpdateFunction();
void moatDrainedSceneUpdateFunction();

} // End of namespace Dragons

#endif // DRAGONS_SPECIALOPCODES_H