Item.h

Go to the documentation of this file.

/*
* This file is part of Project SkyFire https://www.projectskyfire.org.
* See LICENSE.md file for Copyright information
*/
 
#ifndef SKYFIRESERVER_ITEM_H
#define SKYFIRESERVER_ITEM_H
 
#include "Common.h"
#include "DatabaseEnv.h"
#include "ItemPrototype.h"
#include "LootMgr.h"
#include "Object.h"
 
class SpellInfo;
class Bag;
class Unit;
 
struct ItemSetEffect
{
    uint32 setid;
    uint32 item_count;
    SpellInfo const* spells[8];
};
 
enum InventoryResult
{
    EQUIP_ERR_OK = 0,
    EQUIP_ERR_CANT_EQUIP_LEVEL_I = 1,  // You must reach level %d to use that item.
    EQUIP_ERR_CANT_EQUIP_SKILL = 2,  // You aren't skilled enough to use that item.
    EQUIP_ERR_WRONG_SLOT = 3,  // That item does not go in that slot.
    EQUIP_ERR_BAG_FULL = 4,  // That bag is full.
    EQUIP_ERR_BAG_IN_BAG = 5,  // Can't put non-empty bags in other bags.
    EQUIP_ERR_TRADE_EQUIPPED_BAG = 6,  // You can't trade equipped bags.
    EQUIP_ERR_AMMO_ONLY = 7,  // Only ammo can go there.
    EQUIP_ERR_PROFICIENCY_NEEDED = 8,  // You do not have the required proficiency for that item.
    EQUIP_ERR_NO_SLOT_AVAILABLE = 9,  // No equipment slot is available for that item.
    EQUIP_ERR_CANT_EQUIP_EVER = 10, // You can never use that item.
    EQUIP_ERR_CANT_EQUIP_EVER_2 = 11, // You can never use that item.
    EQUIP_ERR_NO_SLOT_AVAILABLE_2 = 12, // No equipment slot is available for that item.
    EQUIP_ERR_2HANDED_EQUIPPED = 13, // Cannot equip that with a two-handed weapon.
    EQUIP_ERR_2HSKILLNOTFOUND = 14, // You cannot dual-wield
    EQUIP_ERR_WRONG_BAG_TYPE = 15, // That item doesn't go in that container.
    EQUIP_ERR_WRONG_BAG_TYPE_2 = 16, // That item doesn't go in that container.
    EQUIP_ERR_ITEM_MAX_COUNT = 17, // You can't carry any more of those items.
    EQUIP_ERR_NO_SLOT_AVAILABLE_3 = 18, // No equipment slot is available for that item.
    EQUIP_ERR_CANT_STACK = 19, // This item cannot stack.
    EQUIP_ERR_NOT_EQUIPPABLE = 20, // This item cannot be equipped.
    EQUIP_ERR_CANT_SWAP = 21, // These items can't be swapped.
    EQUIP_ERR_SLOT_EMPTY = 22, // That slot is empty.
    EQUIP_ERR_ITEM_NOT_FOUND = 23, // The item was not found.
    EQUIP_ERR_DROP_BOUND_ITEM = 24, // You can't drop a soulbound item.
    EQUIP_ERR_OUT_OF_RANGE = 25, // Out of range.
    EQUIP_ERR_TOO_FEW_TO_SPLIT = 26, // Tried to split more than number in stack.
    EQUIP_ERR_SPLIT_FAILED = 27, // Couldn't split those items.
    EQUIP_ERR_SPELL_FAILED_REAGENTS_GENERIC = 28, // Missing reagent
    EQUIP_ERR_NOT_ENOUGH_MONEY = 29, // You don't have enough money.
    EQUIP_ERR_NOT_A_BAG = 30, // Not a bag.
    EQUIP_ERR_DESTROY_NONEMPTY_BAG = 31, // You can only do that with empty bags.
    EQUIP_ERR_NOT_OWNER = 32, // You don't own that item.
    EQUIP_ERR_ONLY_ONE_QUIVER = 33, // You can only equip one quiver.
    EQUIP_ERR_NO_BANK_SLOT = 34, // You must purchase that bag slot first
    EQUIP_ERR_NO_BANK_HERE = 35, // You are too far away from a bank.
    EQUIP_ERR_ITEM_LOCKED = 36, // Item is locked.
    EQUIP_ERR_GENERIC_STUNNED = 37, // You are stunned
    EQUIP_ERR_PLAYER_DEAD = 38, // You can't do that when you're dead.
    EQUIP_ERR_CLIENT_LOCKED_OUT = 39, // You can't do that right now.
    EQUIP_ERR_INTERNAL_BAG_ERROR = 40, // Internal Bag Error
    EQUIP_ERR_ONLY_ONE_BOLT = 41, // You can only equip one quiver.
    EQUIP_ERR_ONLY_ONE_AMMO = 42, // You can only equip one ammo pouch.
    EQUIP_ERR_CANT_WRAP_STACKABLE = 43, // Stackable items can't be wrapped.
    EQUIP_ERR_CANT_WRAP_EQUIPPED = 44, // Equipped items can't be wrapped.
    EQUIP_ERR_CANT_WRAP_WRAPPED = 45, // Wrapped items can't be wrapped.
    EQUIP_ERR_CANT_WRAP_BOUND = 46, // Bound items can't be wrapped.
    EQUIP_ERR_CANT_WRAP_UNIQUE = 47, // Unique items can't be wrapped.
    EQUIP_ERR_CANT_WRAP_BAGS = 48, // Bags can't be wrapped.
    EQUIP_ERR_LOOT_GONE = 49, // Already looted
    EQUIP_ERR_INV_FULL = 50, // Inventory is full.
    EQUIP_ERR_BANK_FULL = 51, // Your bank is full
    EQUIP_ERR_VENDOR_SOLD_OUT = 52, // That item is currently sold out.
    EQUIP_ERR_BAG_FULL_2 = 53, // That bag is full.
    EQUIP_ERR_ITEM_NOT_FOUND_2 = 54, // The item was not found.
    EQUIP_ERR_CANT_STACK_2 = 55, // This item cannot stack.
    EQUIP_ERR_BAG_FULL_3 = 56, // That bag is full.
    EQUIP_ERR_VENDOR_SOLD_OUT_2 = 57, // That item is currently sold out.
    EQUIP_ERR_OBJECT_IS_BUSY = 58, // That object is busy.
    EQUIP_ERR_CANT_BE_DISENCHANTED = 59,
    EQUIP_ERR_NOT_IN_COMBAT = 60, // You can't do that while in combat
    EQUIP_ERR_NOT_WHILE_DISARMED = 61, // You can't do that while disarmed
    EQUIP_ERR_BAG_FULL_4 = 62, // That bag is full.
    EQUIP_ERR_CANT_EQUIP_RANK = 63, // You don't have the required rank for that item
    EQUIP_ERR_CANT_EQUIP_REPUTATION = 64, // You don't have the required reputation for that item
    EQUIP_ERR_TOO_MANY_SPECIAL_BAGS = 65, // You cannot equip another bag of that type
    EQUIP_ERR_LOOT_CANT_LOOT_THAT_NOW = 66, // You can't loot that item now.
    EQUIP_ERR_ITEM_UNIQUE_EQUIPPABLE = 67, // You cannot equip more than one of those.
    EQUIP_ERR_VENDOR_MISSING_TURNINS = 68, // You do not have the required items for that purchase
    EQUIP_ERR_NOT_ENOUGH_HONOR_POINTS = 69, // You don't have enough honor points
    EQUIP_ERR_NOT_ENOUGH_ARENA_POINTS = 70, // You don't have enough arena points
    EQUIP_ERR_ITEM_MAX_COUNT_SOCKETED = 71, // You have the maximum number of those gems in your inventory or socketed into items.
    EQUIP_ERR_MAIL_BOUND_ITEM = 72, // You can't mail soulbound items.
    EQUIP_ERR_INTERNAL_BAG_ERROR_2 = 73, // Internal Bag Error
    EQUIP_ERR_BAG_FULL_5 = 74, // That bag is full.
    EQUIP_ERR_ITEM_MAX_COUNT_EQUIPPED_SOCKETED = 75, // You have the maximum number of those gems socketed into equipped items.
    EQUIP_ERR_ITEM_UNIQUE_EQUIPPABLE_SOCKETED = 76, // You cannot socket more than one of those gems into a single item.
    EQUIP_ERR_TOO_MUCH_GOLD = 77, // At gold limit
    EQUIP_ERR_NOT_DURING_ARENA_MATCH = 78, // You can't do that while in an arena match
    EQUIP_ERR_TRADE_BOUND_ITEM = 79, // You can't trade a soulbound item.
    EQUIP_ERR_CANT_EQUIP_RATING = 80, // You don't have the personal, team, or battleground rating required to buy that item
    EQUIP_ERR_NO_OUTPUT = 81,
    EQUIP_ERR_NOT_SAME_ACCOUNT = 82, // Account-bound items can only be given to your own characters.
    EQUIP_ERR_ITEM_MAX_LIMIT_CATEGORY_COUNT_EXCEEDED_IS = 84, // You can only carry %d %s
    EQUIP_ERR_ITEM_MAX_LIMIT_CATEGORY_SOCKETED_EXCEEDED_IS = 85, // You can only equip %d |4item:items in the %s category
    EQUIP_ERR_SCALING_STAT_ITEM_LEVEL_EXCEEDED = 86, // Your level is too high to use that item
    EQUIP_ERR_PURCHASE_LEVEL_TOO_LOW = 87, // You must reach level %d to purchase that item.
    EQUIP_ERR_CANT_EQUIP_NEED_TALENT = 88, // You do not have the required talent to equip that.
    EQUIP_ERR_ITEM_MAX_LIMIT_CATEGORY_EQUIPPED_EXCEEDED_IS = 89, // You can only equip %d |4item:items in the %s category
    EQUIP_ERR_SHAPESHIFT_FORM_CANNOT_EQUIP = 90, // Cannot equip item in this form
    EQUIP_ERR_ITEM_INVENTORY_FULL_SATCHEL = 91, // Your inventory is full. Your satchel has been delivered to your mailbox.
    EQUIP_ERR_SCALING_STAT_ITEM_LEVEL_TOO_LOW = 92, // Your level is too low to use that item
    EQUIP_ERR_CANT_BUY_QUANTITY = 93, // You can't buy the specified quantity of that item.
    EQUIP_ERR_ITEM_STILL_WAITING_TO_BE_UNLOCKED = 94, // Your purchased item is still waiting to be unlocked.
};
 
enum class BuyResult
{
    BUY_ERR_CANT_FIND_ITEM = 0,  // The item was not found.
    BUY_ERR_ITEM_ALREADY_SOLD = 1,  // That item is currently sold out.
    BUY_ERR_NOT_ENOUGHT_MONEY = 2,  // You don't have enough money.
    BUY_ERR_SELLER_DONT_LIKE_YOU = 4,  // That merchant dosn't like u.
    BUY_ERR_DISTANCE_TOO_FAR = 5,  // You are too far away.
    BUY_ERR_ITEM_SOLD_OUT = 7,  // That item is currently sold out.
    BUY_ERR_CANT_CARRY_MORE = 8,  // You can't carry any more of thouse items.
    BUY_ERR_RANK_REQUIRE = 11, // You don't have the required rank for that item
    BUY_ERR_REPUTATION_REQUIRE = 12  // You don't have the required reputation for that item
};
 
enum class SellResult
{
    SELL_ERR_CANT_FIND_ITEM = 1,
    SELL_ERR_CANT_SELL_ITEM = 2,       // merchant doesn't like that item
    SELL_ERR_CANT_FIND_VENDOR = 3,       // merchant doesn't like you
    SELL_ERR_YOU_DONT_OWN_THAT_ITEM = 4,       // you don't own that item
    SELL_ERR_UNK = 5,       // nothing appears...
    SELL_ERR_ONLY_EMPTY_BAG = 6        // can only do with empty bags
};
 
// -1 from client enchantment slot number
enum EnchantmentSlot
{
    PERM_ENCHANTMENT_SLOT = 0,
    TEMP_ENCHANTMENT_SLOT = 1,
    SOCK_ENCHANTMENT_SLOT = 2,
    SOCK_ENCHANTMENT_SLOT_2 = 3,
    SOCK_ENCHANTMENT_SLOT_3 = 4,
    BONUS_ENCHANTMENT_SLOT = 5,
    PRISMATIC_ENCHANTMENT_SLOT = 6,                    // added at apply special permanent enchantment
    //TODO: 7,
    MAX_INSPECTED_ENCHANTMENT_SLOT = 8,
 
    PROP_ENCHANTMENT_SLOT_0 = 8,                   // used with RandomSuffix
    PROP_ENCHANTMENT_SLOT_1 = 9,                   // used with RandomSuffix
    PROP_ENCHANTMENT_SLOT_2 = 10,                   // used with RandomSuffix and RandomProperty
    PROP_ENCHANTMENT_SLOT_3 = 11,                   // used with RandomProperty
    PROP_ENCHANTMENT_SLOT_4 = 12,                   // used with RandomProperty
    MAX_ENCHANTMENT_SLOT = 13,
};
 
#define MAX_VISIBLE_ITEM_OFFSET       2                     // 2 fields per visible item (entry+enchantment)
 
#define MAX_GEM_SOCKETS               MAX_ITEM_PROTO_SOCKETS// (BONUS_ENCHANTMENT_SLOT-SOCK_ENCHANTMENT_SLOT) and item proto size, equal value expected
 
enum EnchantmentOffset
{
    ENCHANTMENT_ID_OFFSET = 0,
    ENCHANTMENT_DURATION_OFFSET = 1,
    ENCHANTMENT_CHARGES_OFFSET = 2                         // now here not only charges, but something new in wotlk
};
 
#define MAX_ENCHANTMENT_OFFSET    3
 
enum EnchantmentSlotMask
{
    ENCHANTMENT_CAN_SOULBOUND = 0x01,
    ENCHANTMENT_UNK1 = 0x02,
    ENCHANTMENT_UNK2 = 0x04,
    ENCHANTMENT_UNK3 = 0x08
};
 
enum ItemUpdateState
{
    ITEM_UNCHANGED = 0,
    ITEM_CHANGED = 1,
    ITEM_NEW = 2,
    ITEM_REMOVED = 3
};
 
#define MAX_ITEM_SPELLS 5
 
bool ItemCanGoIntoBag(ItemTemplate const* proto, ItemTemplate const* pBagProto);
 
class Item : public Object
{
public:
    static Item* CreateItem(uint32 itemEntry, uint32 count, Player const* player = NULL);
    Item* CloneItem(uint32 count, Player const* player = NULL) const;
 
    Item();
 
    virtual bool Create(uint32 guidlow, uint32 itemid, Player const* owner);
 
    ItemTemplate const* GetTemplate() const;
 
    uint64 GetOwnerGUID()    const { return GetUInt64Value(ITEM_FIELD_OWNER); }
    void SetOwnerGUID(uint64 guid) { SetUInt64Value(ITEM_FIELD_OWNER, guid); }
    Player* GetOwner()const;
 
    void SetBinding(bool val) { ApplyModFlag(ITEM_FIELD_DYNAMIC_FLAGS, ITEM_FLAG_SOULBOUND, val); }
    bool IsSoulBound() const { return HasFlag(ITEM_FIELD_DYNAMIC_FLAGS, ITEM_FLAG_SOULBOUND); }
    bool IsBoundAccountWide() const { return (GetTemplate()->Flags & ITEM_PROTO_FLAG_BIND_TO_ACCOUNT) != 0; }
    bool IsBindedNotWith(Player const* player) const;
    bool IsBoundByEnchant() const;
    virtual void SaveToDB(SQLTransaction& trans);
    virtual bool LoadFromDB(uint32 guid, uint64 owner_guid, Field* fields, uint32 entry);
    static void DeleteFromDB(SQLTransaction& trans, uint32 itemGuid);
    virtual void DeleteFromDB(SQLTransaction& trans);
    static void DeleteFromInventoryDB(SQLTransaction& trans, uint32 itemGuid);
 
    // Lootable items and their contents
    void ItemContainerSaveLootToDB();
    bool ItemContainerLoadLootFromDB();
    void ItemContainerDeleteLootItemsFromDB();
    void ItemContainerDeleteLootItemFromDB(uint32 itemID);
    void ItemContainerDeleteLootMoneyFromDB();
    void ItemContainerDeleteLootMoneyAndLootItemsFromDB();
 
    void DeleteFromInventoryDB(SQLTransaction& trans);
    void SaveRefundDataToDB();
    void DeleteRefundDataFromDB(SQLTransaction* trans);
 
    Bag* ToBag() { if (IsBag()) return reinterpret_cast<Bag*>(this); else return NULL; }
    const Bag* ToBag() const { if (IsBag()) return reinterpret_cast<const Bag*>(this); else return NULL; }
 
    bool IsLocked() const { return !HasFlag(ITEM_FIELD_DYNAMIC_FLAGS, ITEM_FLAG_UNLOCKED); }
    bool IsBag() const { return GetTemplate()->InventoryType == INVTYPE_BAG; }
    bool IsCurrencyToken() const { return GetTemplate()->IsCurrencyToken(); }
    bool IsNotEmptyBag() const;
    bool IsBroken() const { return GetUInt32Value(ITEM_FIELD_MAX_DURABILITY) > 0 && GetUInt32Value(ITEM_FIELD_DURABILITY) == 0; }
    bool CanBeTraded(bool mail = false, bool trade = false) const;
    void SetInTrade(bool b = true) { mb_in_trade = b; }
    bool IsInTrade() const { return mb_in_trade; }
 
    bool HasEnchantRequiredSkill(const Player* player) const;
 
    bool IsFitToSpellRequirements(SpellInfo const* spellInfo) const;
    bool IsLimitedToAnotherMapOrZone(uint32 cur_mapId, uint32 cur_zoneId) const;
    bool GemsFitSockets() const;
 
    uint32 GetCount() const { return GetUInt32Value(ITEM_FIELD_STACK_COUNT); }
    void SetCount(uint32 value) { SetUInt32Value(ITEM_FIELD_STACK_COUNT, value); }
    uint32 GetMaxStackCount() const { return GetTemplate()->GetMaxStackSize(); }
    uint8 GetGemCountWithID(uint32 GemID) const;
    uint8 GetGemCountWithLimitCategory(uint32 limitCategory) const;
    InventoryResult CanBeMergedPartlyWith(ItemTemplate const* proto) const;
 
    uint8 GetSlot() const { return m_slot; }
    Bag* GetContainer() { return m_container; }
    uint8 GetBagSlot() const;
    void SetSlot(uint8 slot) { m_slot = slot; }
    uint16 GetPos() const { return uint16(GetBagSlot()) << 8 | GetSlot(); }
    void SetContainer(Bag* container) { m_container = container; }
 
    bool IsInBag() const { return m_container != NULL; }
    bool IsEquipped() const;
 
    uint32 GetSkill();
 
    // RandomPropertyId (signed but stored as unsigned)
    int32 GetItemRandomPropertyId() const { return GetInt32Value(ITEM_FIELD_RANDOM_PROPERTIES_ID); }
    uint32 GetItemSuffixFactor() const { return GetUInt32Value(ITEM_FIELD_PROPERTY_SEED); }
    void SetItemRandomProperties(int32 randomPropId);
    void UpdateItemSuffixFactor();
    static int32 GenerateItemRandomPropertyId(uint32 item_id);
    void SetEnchantment(EnchantmentSlot slot, uint32 id, uint32 duration, uint32 charges, uint64 caster = 0);
    void SetEnchantmentDuration(EnchantmentSlot slot, uint32 duration, Player* owner);
    void SetEnchantmentCharges(EnchantmentSlot slot, uint32 charges);
    void ClearEnchantment(EnchantmentSlot slot);
    uint32 GetEnchantmentId(EnchantmentSlot slot)       const { return GetUInt32Value(ITEM_FIELD_ENCHANTMENT + slot * MAX_ENCHANTMENT_OFFSET + ENCHANTMENT_ID_OFFSET); }
    uint32 GetEnchantmentDuration(EnchantmentSlot slot) const { return GetUInt32Value(ITEM_FIELD_ENCHANTMENT + slot * MAX_ENCHANTMENT_OFFSET + ENCHANTMENT_DURATION_OFFSET); }
    uint32 GetEnchantmentCharges(EnchantmentSlot slot)  const { return GetUInt32Value(ITEM_FIELD_ENCHANTMENT + slot * MAX_ENCHANTMENT_OFFSET + ENCHANTMENT_CHARGES_OFFSET); }
 
    std::string const& GetText() const { return m_text; }
    void SetText(std::string const& text) { m_text = text; }
 
    void SendTimeUpdate(Player* owner);
    void UpdateDuration(Player* owner, uint32 diff);
 
    // spell charges (signed but stored as unsigned)
    int32 GetSpellCharges(uint8 index/*0..5*/ = 0) const { return GetInt32Value(ITEM_FIELD_SPELL_CHARGES + index); }
    void  SetSpellCharges(uint8 index/*0..5*/, int32 value) { SetInt32Value(ITEM_FIELD_SPELL_CHARGES + index, value); }
 
    Loot loot;
    bool m_lootGenerated;
 
    // Update States
    ItemUpdateState GetState() const { return uState; }
    void SetState(ItemUpdateState state, Player* forplayer = NULL);
    void AddToUpdateQueueOf(Player* player);
    void RemoveFromUpdateQueueOf(Player* player);
    bool IsInUpdateQueue() const { return uQueuePos != -1; }
    uint16 GetQueuePos() const { return uQueuePos; }
    void FSetState(ItemUpdateState state)               // forced
    {
        uState = state;
    }
 
    bool hasQuest(uint32 quest_id) const { return GetTemplate()->StartQuest == quest_id; }
    bool hasInvolvedQuest(uint32 /*quest_id*/) const { return false; }
    bool HasStats() const;
    bool IsPotion() const { return GetTemplate()->IsPotion(); }
    bool IsVellum() const { return GetTemplate()->IsVellum(); }
    bool IsConjuredConsumable() const { return GetTemplate()->IsConjuredConsumable(); }
    bool IsRangedWeapon() const { return GetTemplate()->IsRangedWeapon(); }
 
    // Item Refund system
    void SetNotRefundable(Player* owner, bool changestate = true, SQLTransaction* trans = NULL);
    void SetRefundRecipient(uint32 pGuidLow) { m_refundRecipient = pGuidLow; }
    void SetPaidMoney(uint32 money) { m_paidMoney = money; }
    void SetPaidExtendedCost(uint32 iece) { m_paidExtendedCost = iece; }
 
    uint32 GetRefundRecipient() const { return m_refundRecipient; }
    uint32 GetPaidMoney() const { return m_paidMoney; }
    uint32 GetPaidExtendedCost() const { return m_paidExtendedCost; }
 
    void UpdatePlayedTime(Player* owner);
    uint32 GetPlayedTime();
    bool IsRefundExpired();
 
    // Soulbound trade system
    void SetSoulboundTradeable(AllowedLooterSet const& allowedLooters);
    void ClearSoulboundTradeable(Player* currentOwner);
    bool CheckSoulboundTradeExpire();
 
    void BuildUpdate(UpdateDataMapType&);
 
    uint32 GetScriptId() const { return GetTemplate()->ScriptId; }
 
    bool CanBeTransmogrified() const;
    bool CanTransmogrify() const;
    static bool CanTransmogrifyItemWithItem(Item const* transmogrified, Item const* transmogrifier);
    static uint32 GetSpecialPrice(ItemTemplate const* proto, uint32 minimumPrice = 10000);
    uint32 GetSpecialPrice(uint32 minimumPrice = 10000) const { return Item::GetSpecialPrice(GetTemplate(), minimumPrice); }
 
    uint32 GetVisibleEntry() const
    {
        if (uint32 transmogrification = GetDynamicUInt32Value(ITEM_DYNAMIC_MODIFIERS, 1))
            return transmogrification;
        return GetEntry();
    }
 
    static uint32 GetSellPrice(ItemTemplate const* proto, bool& success);
 
    int32 GetReforgableStat(ItemModType statType) const;
 
private:
    std::string m_text;
    uint8 m_slot;
    Bag* m_container;
    ItemUpdateState uState;
    int16 uQueuePos;
    bool mb_in_trade;                                   // true if item is currently in trade-window
    time_t m_lastPlayedTimeUpdate;
    uint32 m_refundRecipient;
    uint32 m_paidMoney;
    uint32 m_paidExtendedCost;
    AllowedLooterSet allowedGUIDs;
};
#endif