scriptopcodes.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_SCRIPTOPCODES_H
#define DRAGONS_SCRIPTOPCODES_H

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


namespace Dragons {

#define DRAGONS_NUM_SCRIPT_OPCODES 0x23
class DragonsEngine;

struct ScriptOpCall {
    byte _op;
    byte *_base;
    byte *_code;
    byte *_codeEnd;
    int _field8;
    int _result;

    ScriptOpCall(byte *start, uint32 length);
    void skip(uint size);
    byte readByte();
    int16 readSint16();
    uint32 readUint32();
};

typedef Common::Functor1<ScriptOpCall&, void> ScriptOpcode;

class DragonFLG;
class SpecialOpcodes;

class ScriptOpcodes {
public:
    ScriptOpcodes(DragonsEngine *vm, DragonFLG *dragonFLG);
    ~ScriptOpcodes();
    void runScript(ScriptOpCall &scriptOpCall);
    void runScript3(ScriptOpCall &scriptOpCall);
    bool runScript4(ScriptOpCall &scriptOpCall);
    void execOpcode(ScriptOpCall &scriptOpCall);
    void executeScriptLoop(ScriptOpCall &scriptOpCall);
    void loadTalkDialogEntries(ScriptOpCall &scriptOpCall);

    int16 _numDialogStackFramesToPop;
    int16 _scriptTargetINI;
    SpecialOpcodes *_specialOpCodes;

protected:
    DragonsEngine *_vm;
    DragonFLG *_dragonFLG;
    ScriptOpcode *_opcodes[DRAGONS_NUM_SCRIPT_OPCODES];
    Common::String _opcodeNames[DRAGONS_NUM_SCRIPT_OPCODES];

    void initOpcodes();
    void freeOpcodes();
    void updateReturn(ScriptOpCall &scriptOpCall, uint16 size);


    // Opcodes
    void opUnk1(ScriptOpCall &scriptOpCall);
    void opAddDialogChoice(ScriptOpCall &scriptOpCall);
    void opPopDialogStack(ScriptOpCall &scriptOpCall);
    void opExecuteScript(ScriptOpCall &scriptOpCall); //op 4
    void opSetActorDirection(ScriptOpCall &scriptOpCall); //op 5
    void opPerformActionOnObject(ScriptOpCall &scriptOpCall);
    void opMoveObjectToScene(ScriptOpCall &scriptOpCall);
    void opActorLoadSequence(ScriptOpCall &scriptOpCall);

    void opSetVariable(ScriptOpCall &scriptOpCall);
    void opRunSpecialOpCode(ScriptOpCall &scriptOpCall); //op B
    void opPlayOrStopSound(ScriptOpCall &scriptOpCall);
    void opDelay(ScriptOpCall &scriptOpCall); //op D
    void opMoveActorToPoint(ScriptOpCall &scriptOpCall);
    void opMoveActorToXY(ScriptOpCall &scriptOpCall);
    void opMoveActorToObject(ScriptOpCall &scriptOpCall);
    void opUnk11FlickerTalk(ScriptOpCall &scriptOpCall);
    void opLoadScene(ScriptOpCall &scriptOpCall);
    void opIfStatement(ScriptOpCall &scriptOpCall);
    void opIfElseStatement(ScriptOpCall &scriptOpCall);
    void opUnk15PropertiesRelated(ScriptOpCall &scriptOpCall);
    void opUnk16(ScriptOpCall &scriptOpCall);
    void opWaitForActorSequenceToFinish(ScriptOpCall &scriptOpCall);
    void opDialogAtPoint(ScriptOpCall &scriptOpCall);
    void opExecuteObjectSceneScript(ScriptOpCall &scriptOpCall);
    void opUpdatePaletteCycling(ScriptOpCall &scriptOpCall);
    void opWaitForActorToFinishWalking(ScriptOpCall &scriptOpCall);
    void opShowActor(ScriptOpCall &scriptOpCall);
    void opHideActor(ScriptOpCall &scriptOpCall);
    void opSetActorFlag0x1000(ScriptOpCall &scriptOpCall);
    void opPlayMusic(ScriptOpCall &scriptOpCall);
    void opPreLoadSceneData(ScriptOpCall &scriptOpCall);
    void opPauseCurrentSpeechAndFetchNextDialog(ScriptOpCall &scriptOpCall);

    bool evaluateExpression(ScriptOpCall &scriptOpCall);
    void setVariable(ScriptOpCall &scriptOpCall);
    void opCode_Unk7(ScriptOpCall &scriptOpCall);

    void opCodeActorTalk(ScriptOpCall &scriptOpCall); // 0x22

    // misc
    uint16 getINIField(uint32 iniIndex, uint16 fieldOffset);
    void setINIField(uint32 iniIndex, uint16 fieldOffset, uint16 value);
};

} // End of namespace Dragons

#endif // DRAGONS_SCRIPTOPCODES_H