kyra_rpg.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 KYRA_RPG_H
#define KYRA_RPG_H

#if defined(ENABLE_EOB) || defined(ENABLE_LOL)

#include "kyra/kyra_v1.h"
#include "kyra/graphics/screen_eob.h"
#include "kyra/gui/gui_eob.h"
#include "kyra/text/text_lol.h"

#include "common/keyboard.h"
#include "backends/keymapper/action.h"

namespace {
    class Action;
}

namespace Kyra {

struct LevelDecorationProperty {
    uint16 shapeIndex[10];
    uint8 scaleFlag[10];
    int16 shapeX[10];
    int16 shapeY[10];
    int8 next;
    uint8 flags;
};

struct LevelBlockProperty {
    uint8 walls[4];
    uint16 assignedObjects;
    uint16 drawObjects;
    uint8 direction;
    uint16 flags;
};

struct OpenDoorState {
    uint16 block;
    int8 wall;
    int8 state;
};

struct LevelTempData {
    uint8 *wallsXorData;
    uint16 *flags;
    void *monsters;
    void *flyingObjects;
    void *wallsOfForce;
    uint8 monsterDifficulty;
};

struct EoBFlyingObject {
    uint8 enable;
    uint8 objectType;
    int16 attackerId;
    Item item;
    uint16 curBlock;
    uint16 starting;
    uint8 u1;
    uint8 direction;
    uint8 distance;
    int8 callBackIndex;
    uint8 curPos;
    uint8 flags;
    Item projectileWeapon;
};

struct KyraRpgGUISettings {
    struct DialogueButtons {
        const uint16 *posX;
        const uint8 *posY;
        uint8 labelColor1;
        uint8 labelColor2;
        bool labelShadow;
        uint16 width;
        uint16 height;
        int16 txtOffsY;
        int waitReserve;
        uint16 waitX[2];
        uint8 waitY[2];
        uint16 waitWidth[2];
    } buttons;

    struct Colors {
        uint8 frame1;
        uint8 frame2;
        int fill;

        uint8 sfill;
        uint8 barGraph;

        uint8 warningFrame1;
        uint8 warningFrame2;
        int warningFill;

        uint8 extraFrame1;
        uint8 extraFrame2;
        int extraFill;

        uint8 inactiveTabFrame1;
        uint8 inactiveTabFrame2;
        int inactiveTabFill;

        uint8 guiColorWhite;
        uint8 guiColorLightRed;
        uint8 guiColorDarkRed;
        uint8 guiColorLightBlue;
        uint8 guiColorBlue;
        uint8 guiColorDarkBlue;
        uint8 guiColorYellow;
        uint8 guiColorLightGreen;
        uint8 guiColorDarkGreen;
        uint8 guiColorPurple;
        uint8 guiColorBrown;
        uint8 guiColorBlack;
    } colors;

    struct CharacterBoxCoords {
        int16 boxX[3];
        int16 boxY[3];
        uint8 boxWidth;
        uint8 boxHeight;
        int16 facePosX_1[3];
        int16 facePosY_1[3];
        int16 facePosX_2[3];
        int16 facePosY_2[3];
        int16 weaponSlotX[3];
        int16 weaponSlotY[6];
        int16 hpBarX_1[3];
        int16 hpBarY_1[3];
        uint8 hpBarWidth_1;
        uint8 hpBarHeight_1;
        int16 hpFoodBarX_2[3];
        int16 hpFoodBarY_2[3];
        uint8 hpFoodBarWidth_2[2];
        uint8 hpFoodBarHeight_2;
        int16 nameLabelOffsetX;
        int16 nameLabelOffsetY;
        int16 exchangeLabelOffsetX;
        int16 exchangeLabelOffsetY;
        int16 redSplatOffsetX;
        int16 redSplatOffsetY;
    } charBoxCoords;

    struct StatsPageCoords {
        int16 headlineX;
        int16 headlineY;
        int16 descStartX;
        int16 descStartY;
        uint8 descYInc;
        int16 statsGroup1StringsX;
        int16 statsGroup1StringsY;
        int16 statsGroup2StringsX;
        int16 statsGroup2StringsY;
        uint8 statsStringsYInc;
        int16 statsGroup1StatsX;
        int16 statsGroup1StatsY;
        int16 statsGroup2StatsX;
        int16 statsGroup2StatsY;
        uint8 statsStatsYInc;
        int16 acStringX;
        int16 acStringY;
        int16 acStatsX;
        int16 acStatsY;
        int16 expStringX;
        int16 expStringY;
        int16 expStatsX;
        int16 expStatsY;
        uint8 expStatsXInc;
        uint8 expStatsYInc;
        int16 lvlStringX;
        int16 lvlStringY;
        int16 lvlStatsX;
        int16 lvlStatsY;
        uint8 lvlStatsXInc;
        uint8 lvlStatsYInc;
        int16 classStringsX;
        int16 classStringsY;
        uint8 classStringsXInc;
        uint8 classStringsYInc;
    } statsPageCoords;

    struct StatsPageColors {
        uint8 headLine;
        uint8 cls[3];
        uint8 alignment;
        uint8 race;
        uint8 acString;
        uint8 statsStrings;
        uint8 statsValues;
        uint8 expLvl[3];
    } statsPageColors;

    struct SpellbookCoords {
        uint8 totalHeight;
        uint8 numTabs;
        uint8 tabStartX;
        uint8 tabStartY;
        uint8 tabWidth;
        uint8 tabHeight;
        uint8 tabStrOffsX;
        uint8 tabStrOffsY;
        uint8 listSize;
        uint8 listStartX;
        uint8 listStartY;
        uint8 listTotalH;
        uint8 abortBtnX;
        uint8 abortBtnY;
        uint8 abortBtnW;
        uint8 abortBtnH;
        uint8 abortStrX;
        uint8 abortStrY;
        uint8 scrollButtonY;
        uint8 gridCoordsX[4];
        uint8 gridCoordsY[3];
    } spellbookCoords;
};

class KyraRpgEngine : public KyraEngine_v1 {
friend class TextDisplayer_rpg;
public:
    KyraRpgEngine(OSystem *system, const GameFlags &flags);
    ~KyraRpgEngine() override;

    Screen *screen() override = 0;
    GUI *gui() const override = 0;

protected:
    // Startup
    Common::Error init() override;
    Common::Error go() override = 0;

    // Init
    void initStaticResource();

    static void addKeymapAction(Common::Keymap *const keyMap, const char *actionId, const Common::U32String &actionDesc, const Common::Functor0Mem<void, Common::Action>::FuncType setEventProc, const Common::String &mapping1, const Common::String &mapping2);
    static void addKeymapAction(Common::Keymap *const keyMap, const char *actionId, const Common::U32String &actionDesc, Common::KeyState eventKeyState, const Common::String &mapping1, const Common::String &mapping2);

    const uint8 **_itemIconShapes;

    // Main loop
    virtual void update() = 0;
    void snd_updateEnvironmentalSfx(int soundId);

    // timers
    void setupTimers() override = 0;
    virtual void enableSysTimer(int sysTimer);
    virtual void disableSysTimer(int sysTimer);
    void enableTimer(int id);
    virtual uint8 getClock2Timer(int index) = 0;
    virtual uint8 getNumClock2Timers() = 0;

    void timerProcessDoors(int timerNum);

    // mouse
    bool posWithinRect(int posX, int posY, int x1, int y1, int x2, int y2);
    void setHandItem(Item itemIndex) override = 0;

    // Characters
    int _updateCharNum;
    int _updatePortraitSpeechAnimDuration;
    bool _fadeText;
    int _resetPortraitAfterSpeechAnim;
    int _needSceneRestore;

    // Items
    int _itemInHand;

    // Monsters
    int getBlockDistance(uint16 block1, uint16 block2);

    uint8 **_monsterPalettes;
    uint8 **_monsterShapes;

    int16 _shpDmX1;
    int16 _shpDmX2;

    int _monsterStepCounter;
    int _monsterStepMode;

    // Level
    virtual void addLevelItems() = 0;
    virtual void loadBlockProperties(const char *file) = 0;

    virtual const uint8 *getBlockFileData(int levelIndex) = 0;
    void setLevelShapesDim(int index, int16 &x1, int16 &x2, int dim);
    void setDoorShapeDim(int index, int16 &y1, int16 &y2, int dim);
    void drawLevelModifyScreenDim(int dim, int16 x1, int16 y1, int16 x2, int16 y2);
    void generateBlockDrawingBuffer();
    void generateVmpTileData(int16 startBlockX, uint8 startBlockY, uint8 wllVmpIndex, int16 vmpOffset, uint8 numBlocksX, uint8 numBlocksY);
    void generateVmpTileDataFlipped(int16 startBlockX, uint8 startBlockY, uint8 wllVmpIndex, int16 vmpOffset, uint8 numBlocksX, uint8 numBlocksY);
    bool hasWall(int index);
    void assignVisibleBlocks(int block, int direction);
    bool checkSceneUpdateNeed(int block);
    uint16 calcNewBlockPosition(uint16 curBlock, uint16 direction);

    void drawVcnBlocks();
    void vcnDraw_fw_4bit(uint8 *&dst, const uint8 *&src);
    void vcnDraw_bw_4bit(uint8 *&dst, const uint8 *&src);
    void vcnDraw_fw_trans_4bit(uint8 *&dst, const uint8 *&src);
    void vcnDraw_bw_trans_4bit(uint8 *&dst, const uint8 *&src);
    void vcnDraw_fw_hiCol(uint8 *&dst, const uint8 *&src);
    void vcnDraw_bw_hiCol(uint8 *&dst, const uint8 *&src);
    void vcnDraw_fw_trans_hiCol(uint8 *&dst, const uint8 *&src);
    void vcnDraw_bw_trans_hiCol(uint8 *&dst, const uint8 *&src);
    void vcnDraw_fw_planar(uint8 *&dst, const uint8 *&src);
    void vcnDraw_bw_planar(uint8 *&dst, const uint8 *&src);
    void vcnDraw_fw_trans_planar(uint8 *&dst, const uint8 *&src);
    void vcnDraw_bw_trans_planar(uint8 *&dst, const uint8 *&src);

    typedef Common::Functor2Mem<uint8 *&, const uint8 *&, void, KyraRpgEngine> VcnDrawProc;
    struct VcnLineDrawingMethods {
        VcnLineDrawingMethods(VcnDrawProc *fw, VcnDrawProc *bw, VcnDrawProc *fw_t, VcnDrawProc *bw_t) : forward(fw), backwards(bw), forward_trans(fw_t), backwards_trans(bw_t) {}
        ~VcnLineDrawingMethods() {
            delete forward;
            delete backwards;
            delete forward_trans;
            delete backwards_trans;
        }

        VcnDrawProc *forward;
        VcnDrawProc *backwards;
        VcnDrawProc *forward_trans;
        VcnDrawProc *backwards_trans;
    };
    VcnLineDrawingMethods *_vcnDrawLine;

    virtual int clickedDoorSwitch(uint16 block, uint16 direction) = 0;
    int clickedWallShape(uint16 block, uint16 direction);
    int clickedLeverOn(uint16 block, uint16 direction);
    int clickedLeverOff(uint16 block, uint16 direction);
    int clickedWallOnlyScript(uint16 block);
    virtual int clickedNiche(uint16 block, uint16 direction) = 0;

    void processDoorSwitch(uint16 block, int openClose);
    void openCloseDoor(int block, int openClose);
    void completeDoorOperations();
    bool isSpecialDoor(int block);

    uint8 *_wllVmpMap;
    int8 *_wllShapeMap;
    uint8 *_specialWallTypes;
    uint8 *_wllWallFlags;

    int _sceneXoffset;
    int _sceneShpDim;

    LevelBlockProperty *_levelBlockProperties;
    LevelBlockProperty *_visibleBlocks[18];
    LevelDecorationProperty *_levelDecorationData;
    uint16 _levelDecorationDataSize;
    LevelDecorationProperty *_levelDecorationProperties;
    const uint8 **_levelDecorationShapes;
    uint16 _decorationCount;
    int16 _mappedDecorationsCount;
    uint16 *_vmpPtr;
    uint8 *_vcnBlocks;
    uint8 *_vcfBlocks;
    uint8 *_vcnTransitionMask;
    uint8 *_vcnMaskTbl;
    uint8 *_vcnShift;
    uint8 _vcnShiftVal;
    uint8 *_vcnColTable;
    uint8 _vcnSrcBitsPerPixel;
    uint8 _vcnBpp;
    uint16 *_blockDrawingBuffer;
    uint8 *_sceneWindowBuffer;
    uint8 _blockBrightness;
    uint8 _wllVcnOffset;
    uint8 _wllVcnOffset2;
    uint8 _wllVcnRmdOffset;

    uint8 **_doorShapes;

    uint8 _currentLevel;
    uint16 _currentBlock;
    uint16 _currentDirection;
    int _sceneDefaultUpdate;
    bool _sceneUpdateRequired;

    int16 _visibleBlockIndex[18];
    int16 *_lvlShapeLeftRight;
    int16 *_lvlShapeTop;
    int16 *_lvlShapeBottom;

    Common::String _lastBlockDataFile;
    uint32 _hasTempDataFlags;

    int16 _sceneDrawVarDown;
    int16 _sceneDrawVarRight;
    int16 _sceneDrawVarLeft;
    int _wllProcessFlag;

    OpenDoorState _openDoorState[3];

    int _sceneDrawPage1;
    int _sceneDrawPage2;

    const int8 *_dscShapeIndex;
    const uint8 *_dscDimMap;
    const int8 *_dscDim1;
    const int8 *_dscDim2;
    const int16 *_dscShapeX;
    const uint8 *_dscDoorScaleOffs;
    const uint8 *_dscBlockMap;
    const int8 *_dscBlockIndex;
    const uint8 *_dscTileIndex;

    const uint8 *_dscDoorShpIndex;
    int _dscDoorShpIndexSize;
    const uint8 *_dscDoorY2;
    const uint8 *_dscDoorFrameY1;
    const uint8 *_dscDoorFrameY2;
    const uint8 *_dscDoorFrameIndex1;
    const uint8 *_dscDoorFrameIndex2;

    const uint16 *_vmpVisOffs;
    static const uint16 _vmpOffsetsDefault[9];
    static const uint16 _vmpOffsetsSegaCD[9];

    // Script
    virtual void runLevelScript(int block, int flags) = 0;

    // Gui
    void removeInputTop();
    void gui_drawBox(int x, int y, int w, int h, int frameColor1, int frameColor2, int fillColor);
    virtual void gui_drawHorizontalBarGraph(int x, int y, int w, int h, int32 curVal, int32 maxVal, int col1, int col2);
    void gui_initButtonsFromList(const uint8 *list);
    virtual void gui_initButton(int index, int x = -1, int y = -1, int val = -1) = 0;
    void gui_resetButtonList();
    void gui_notifyButtonListChanged();

    bool clickedShape(int shapeIndex);

    virtual const KyraRpgGUISettings *guiSettings() const = 0;
    virtual void useMainMenuGUISettings(bool toggle) {};

    int _clickedShapeXOffs;
    int _clickedShapeYOffs;

    Button *_activeButtons;
    Button _activeButtonData[70];
    Common::Array<Button::Callback> _buttonCallbacks;
    //bool _processingButtons;

    uint8 _mouseClick;
    bool _preserveEvents;
    bool _buttonListChanged;

    int _updateFlags;
    int _clickedSpecialFlag;

    int _compassDirection;

    static const uint8 _dropItemDirIndex[];

    // text
    virtual void drawDialogueButtons();
    uint16 processDialogue();

    TextDisplayer_rpg *_txt;
    virtual TextDisplayer_rpg *txt() { return _txt; }

    bool _dialogueField;
    bool _dialogueFieldAmiga;
    Screen::FontId _buttonFont;

    const char *_dialogueButtonString[9];
    const uint16 *_dialogueButtonPosX;
    const uint8 *_dialogueButtonPosY;
    int16 _dialogueButtonXoffs;
    int16 _dialogueButtonYoffs;
    uint16 _dialogueButtonWidth;
    int _dialogueNumButtons;
    int _dialogueHighlightedButton;
    int _currentControlMode;
    int _specialSceneFlag;
    uint8 _dialogueButtonLabelColor1;
    uint8 _dialogueButtonLabelColor2;

    const char *const *_moreStrings;

    static const uint16 _dlgButtonPosX_Def[14];
    static const uint8 _dlgButtonPosY_Def[14];

    // misc
    void delay(uint32 millis, bool doUpdate = false, bool isMainLoop = false) override = 0;
    void delayUntil(uint32 time, bool unused = false, bool doUpdate = false, bool isMainLoop = false) override;
    int rollDice(int times, int pips, int inc = 0);

    Common::Error loadGameState(int slot) override = 0;
    Common::Error saveGameStateIntern(int slot, const char *saveName, const Graphics::Surface *thumbnail) override = 0;

    void generateTempData();
    virtual void restoreBlockTempData(int levelIndex);
    void releaseTempData();
    virtual void *generateMonsterTempData(LevelTempData *tmp) = 0;
    virtual void restoreMonsterTempData(LevelTempData *tmp) = 0;
    virtual void releaseMonsterTempData(LevelTempData *tmp) = 0;
    void restoreFlyingObjectTempData(LevelTempData *tmp);
    void *generateFlyingObjectTempData(LevelTempData *tmp);
    void releaseFlyingObjectTempData(LevelTempData *tmp);
    virtual void *generateWallOfForceTempData(LevelTempData *tmp) { return 0; }
    virtual void restoreWallOfForceTempData(LevelTempData *tmp) {}
    virtual void releaseWallOfForceTempData(LevelTempData *tmp) {}

    LevelTempData *_lvlTempData[29];
    const int _numFlyingObjects;
    uint32 _flyingObjectStructSize;
    void *_flyingObjectsPtr;

    Common::String _versionString;

    // sound
    virtual bool snd_processEnvironmentalSoundEffect(int soundId, int block);
    virtual void snd_stopSpeech(bool) {}
    virtual int snd_updateCharacterSpeech() { return 0; }
    virtual void stopPortraitSpeechAnim() {}
    void setupOpcodeTable() override {}
    void snd_playVoiceFile(int) override {}

    int _environmentSfx;
    int _environmentSfxVol;
    int _envSfxDistThreshold;

    uint32 _activeVoiceFileTotalTime;

    // unused
    void setWalkspeed(uint8) override {}
    void removeHandItem() override {}
    bool lineIsPassable(int, int) override { return false; }
};

} // End of namespace Kyra

#endif // ENABLE_EOB || ENABLE_LOL

#endif