items.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 MM1_DATA_ITEMS_H
#define MM1_DATA_ITEMS_H

#include "common/array.h"
#include "common/stream.h"
#include "mm/mm1/data/text_parser.h"

namespace MM {
namespace MM1 {

enum ItemId {
    GARLIC_ID = 175,
    WOLFSBANE_ID = 176,
    BELLADONNA_ID = 177,
    VELLUM_SCROLL_ID = 231,
    RUBY_WHISTLE_ID = 232,
    KINGS_PASS_ID = 233,
    MERCHANTS_PASS_ID = 234,
    CRYSTAL_KEY_ID = 235,
    CORAL_KEY_ID = 236,
    BRONZE_KEY_ID = 237,
    SILVER_KEY_ID = 238,
    GOLD_KEY_ID = 239,
    DIAMOND_KEY_ID = 240,
    CACTUS_NECTAR_ID = 241,
    MAP_OF_DESERT_ID = 242,
    LASER_BLASTER_ID = 243,
    DRAGONS_TOOTH_ID = 244,
    WYVERN_EYE_ID = 245,
    MEDUSA_HEAD_ID = 246,
    RING_OF_OKRIM_ID = 247,
    B_QUEEN_IDOL_ID = 248,
    W_QUEEN_IDOL_ID = 249,
    PIRATES_MAP_A_ID = 250,
    PIRATES_MAP_B_ID = 251,
    THUNDRANIUM_ID = 252,
    KEY_CARD_ID = 253,
    EYE_OF_GOROS_ID = 254,
    USELESS_ITEM_ID = 255
};

enum EnablementBit {
    KNIGHT_BIT = 0x20, PALADIN_BIT = 0x10, ARCHER_BIT = 8,
    CLERIC_BIT = 4, SORCERER_BIT = 2, ROBBER_BIT = 1,
    GOOD_BIT = 0x80, EVIL_BIT = 0x40,
    NEUTRAL_BIT = GOOD_BIT | EVIL_BIT
};

enum ItemCategory {
    ITEMCAT_NONE, ITEMCAT_WEAPON, ITEMCAT_MISSILE,
    ITEMCAT_TWO_HANDED, ITEMCAT_ARMOR, ITEMCAT_SHIELD
};

enum EquipMode {
    NO_EQUIP_BONUS = 0, IS_EQUIPPABLE = 1,
    EQUIP_CURSED = 0xff
};

enum TransferKind {
    TK_GEMS = 1, TK_GOLD = 2, TK_FOOD = 3, TK_ITEM = 4
};


struct ItemData {
    byte _disablements = 0;
    byte _constBonus_id = 0;  // id equals to character characteristic id, except special "EquipMode" values
    byte _constBonus_value = 0; // value to be added to character characteristic 
    byte _tempBonus_id = 0;  // id equals to character characteristic id, except 0xff
    byte _tempBonus_value = 0; // value to be added to character characteristic 
    byte _spellId = 0;
    byte _maxCharges = 0; // for spells and tempBonus
    uint16 _cost = 0;
    byte _damage = 0;
    byte _AC_Dmg = 0; //it is AC for armor and additional damage for weapon
};

struct Item : public ItemData {
    Common::String _name;

    uint getSellCost() const;
};

struct ItemsArray : public Common::Array<Item>, public TextParser {
    ItemsArray() {}

    bool load();

    Item *getItem(byte index) const;
};

inline bool isWeapon(byte id) {
    return id >= 1 && id <= 60;
}
inline bool isMissile(byte id) {
    return id >= 61 && id <= 85;
}
inline bool isTwoHanded(byte id) {
    return id >= 86 && id <= 120;
}
inline bool isArmor(byte id) {
    return id >= 121 && id <= 155;
}
inline bool isShield(byte id) {
    return id >= 156 && id <= 170;
}

extern ItemCategory getItemCategory(byte itemId);

} // namespace MM1
} // namespace MM

#endif