2 * Copyright (C) 2005-2010 MaNGOS <http://getmangos.com/>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #ifndef MANGOSSERVER_ITEM_H
20 #define MANGOSSERVER_ITEM_H
25 #include "ItemPrototype.h"
36 SpellEntry
const *spells
[8];
39 enum InventoryChangeFailure
42 EQUIP_ERR_CANT_EQUIP_LEVEL_I
= 1, // ERR_CANT_EQUIP_LEVEL_I
43 EQUIP_ERR_CANT_EQUIP_SKILL
= 2, // ERR_CANT_EQUIP_SKILL
44 EQUIP_ERR_ITEM_DOESNT_GO_TO_SLOT
= 3, // ERR_WRONG_SLOT
45 EQUIP_ERR_BAG_FULL
= 4, // ERR_BAG_FULL
46 EQUIP_ERR_NONEMPTY_BAG_OVER_OTHER_BAG
= 5, // ERR_BAG_IN_BAG
47 EQUIP_ERR_CANT_TRADE_EQUIP_BAGS
= 6, // ERR_TRADE_EQUIPPED_BAG
48 EQUIP_ERR_ONLY_AMMO_CAN_GO_HERE
= 7, // ERR_AMMO_ONLY
49 EQUIP_ERR_NO_REQUIRED_PROFICIENCY
= 8, // ERR_PROFICIENCY_NEEDED
50 EQUIP_ERR_NO_EQUIPMENT_SLOT_AVAILABLE
= 9, // ERR_NO_SLOT_AVAILABLE
51 EQUIP_ERR_YOU_CAN_NEVER_USE_THAT_ITEM
= 10, // ERR_CANT_EQUIP_EVER
52 EQUIP_ERR_YOU_CAN_NEVER_USE_THAT_ITEM2
= 11, // ERR_CANT_EQUIP_EVER
53 EQUIP_ERR_NO_EQUIPMENT_SLOT_AVAILABLE2
= 12, // ERR_NO_SLOT_AVAILABLE
54 EQUIP_ERR_CANT_EQUIP_WITH_TWOHANDED
= 13, // ERR_2HANDED_EQUIPPED
55 EQUIP_ERR_CANT_DUAL_WIELD
= 14, // ERR_2HSKILLNOTFOUND
56 EQUIP_ERR_ITEM_DOESNT_GO_INTO_BAG
= 15, // ERR_WRONG_BAG_TYPE
57 EQUIP_ERR_ITEM_DOESNT_GO_INTO_BAG2
= 16, // ERR_WRONG_BAG_TYPE
58 EQUIP_ERR_CANT_CARRY_MORE_OF_THIS
= 17, // ERR_ITEM_MAX_COUNT
59 EQUIP_ERR_NO_EQUIPMENT_SLOT_AVAILABLE3
= 18, // ERR_NO_SLOT_AVAILABLE
60 EQUIP_ERR_ITEM_CANT_STACK
= 19, // ERR_CANT_STACK
61 EQUIP_ERR_ITEM_CANT_BE_EQUIPPED
= 20, // ERR_NOT_EQUIPPABLE
62 EQUIP_ERR_ITEMS_CANT_BE_SWAPPED
= 21, // ERR_CANT_SWAP
63 EQUIP_ERR_SLOT_IS_EMPTY
= 22, // ERR_SLOT_EMPTY
64 EQUIP_ERR_ITEM_NOT_FOUND
= 23, // ERR_ITEM_NOT_FOUND
65 EQUIP_ERR_CANT_DROP_SOULBOUND
= 24, // ERR_DROP_BOUND_ITEM
66 EQUIP_ERR_OUT_OF_RANGE
= 25, // ERR_OUT_OF_RANGE
67 EQUIP_ERR_TRIED_TO_SPLIT_MORE_THAN_COUNT
= 26, // ERR_TOO_FEW_TO_SPLIT
68 EQUIP_ERR_COULDNT_SPLIT_ITEMS
= 27, // ERR_SPLIT_FAILED
69 EQUIP_ERR_MISSING_REAGENT
= 28, // ERR_SPELL_FAILED_REAGENTS_GENERIC
70 EQUIP_ERR_NOT_ENOUGH_MONEY
= 29, // ERR_NOT_ENOUGH_MONEY
71 EQUIP_ERR_NOT_A_BAG
= 30, // ERR_NOT_A_BAG
72 EQUIP_ERR_CAN_ONLY_DO_WITH_EMPTY_BAGS
= 31, // ERR_DESTROY_NONEMPTY_BAG
73 EQUIP_ERR_DONT_OWN_THAT_ITEM
= 32, // ERR_NOT_OWNER
74 EQUIP_ERR_CAN_EQUIP_ONLY1_QUIVER
= 33, // ERR_ONLY_ONE_QUIVER
75 EQUIP_ERR_MUST_PURCHASE_THAT_BAG_SLOT
= 34, // ERR_NO_BANK_SLOT
76 EQUIP_ERR_TOO_FAR_AWAY_FROM_BANK
= 35, // ERR_NO_BANK_HERE
77 EQUIP_ERR_ITEM_LOCKED
= 36, // ERR_ITEM_LOCKED
78 EQUIP_ERR_YOU_ARE_STUNNED
= 37, // ERR_GENERIC_STUNNED
79 EQUIP_ERR_YOU_ARE_DEAD
= 38, // ERR_PLAYER_DEAD
80 EQUIP_ERR_CANT_DO_RIGHT_NOW
= 39, // ERR_CLIENT_LOCKED_OUT
81 EQUIP_ERR_INT_BAG_ERROR
= 40, // ERR_INTERNAL_BAG_ERROR
82 EQUIP_ERR_CAN_EQUIP_ONLY1_QUIVER2
= 41, // ERR_ONLY_ONE_BOLT
83 EQUIP_ERR_CAN_EQUIP_ONLY1_AMMOPOUCH
= 42, // ERR_ONLY_ONE_AMMO
84 EQUIP_ERR_STACKABLE_CANT_BE_WRAPPED
= 43, // ERR_CANT_WRAP_STACKABLE
85 EQUIP_ERR_EQUIPPED_CANT_BE_WRAPPED
= 44, // ERR_CANT_WRAP_EQUIPPED
86 EQUIP_ERR_WRAPPED_CANT_BE_WRAPPED
= 45, // ERR_CANT_WRAP_WRAPPED
87 EQUIP_ERR_BOUND_CANT_BE_WRAPPED
= 46, // ERR_CANT_WRAP_BOUND
88 EQUIP_ERR_UNIQUE_CANT_BE_WRAPPED
= 47, // ERR_CANT_WRAP_UNIQUE
89 EQUIP_ERR_BAGS_CANT_BE_WRAPPED
= 48, // ERR_CANT_WRAP_BAGS
90 EQUIP_ERR_ALREADY_LOOTED
= 49, // ERR_LOOT_GONE
91 EQUIP_ERR_INVENTORY_FULL
= 50, // ERR_INV_FULL
92 EQUIP_ERR_BANK_FULL
= 51, // ERR_BAG_FULL
93 EQUIP_ERR_ITEM_IS_CURRENTLY_SOLD_OUT
= 52, // ERR_VENDOR_SOLD_OUT
94 EQUIP_ERR_BAG_FULL3
= 53, // ERR_BAG_FULL
95 EQUIP_ERR_ITEM_NOT_FOUND2
= 54, // ERR_ITEM_NOT_FOUND
96 EQUIP_ERR_ITEM_CANT_STACK2
= 55, // ERR_CANT_STACK
97 EQUIP_ERR_BAG_FULL4
= 56, // ERR_BAG_FULL
98 EQUIP_ERR_ITEM_SOLD_OUT
= 57, // ERR_VENDOR_SOLD_OUT
99 EQUIP_ERR_OBJECT_IS_BUSY
= 58, // ERR_OBJECT_IS_BUSY
100 EQUIP_ERR_NONE
= 59, // ERR_CANT_BE_DISENCHANTED
101 EQUIP_ERR_NOT_IN_COMBAT
= 60, // ERR_NOT_IN_COMBAT
102 EQUIP_ERR_NOT_WHILE_DISARMED
= 61, // ERR_NOT_WHILE_DISARMED
103 EQUIP_ERR_BAG_FULL6
= 62, // ERR_BAG_FULL
104 EQUIP_ERR_CANT_EQUIP_RANK
= 63, // ERR_CANT_EQUIP_RANK
105 EQUIP_ERR_CANT_EQUIP_REPUTATION
= 64, // ERR_CANT_EQUIP_REPUTATION
106 EQUIP_ERR_TOO_MANY_SPECIAL_BAGS
= 65, // ERR_TOO_MANY_SPECIAL_BAGS
107 EQUIP_ERR_LOOT_CANT_LOOT_THAT_NOW
= 66, // ERR_LOOT_CANT_LOOT_THAT_NOW
108 EQUIP_ERR_ITEM_UNIQUE_EQUIPABLE
= 67, // ERR_ITEM_UNIQUE_EQUIPPABLE
109 EQUIP_ERR_VENDOR_MISSING_TURNINS
= 68, // ERR_VENDOR_MISSING_TURNINS
110 EQUIP_ERR_NOT_ENOUGH_HONOR_POINTS
= 69, // ERR_NOT_ENOUGH_HONOR_POINTS
111 EQUIP_ERR_NOT_ENOUGH_ARENA_POINTS
= 70, // ERR_NOT_ENOUGH_ARENA_POINTS
112 EQUIP_ERR_ITEM_MAX_COUNT_SOCKETED
= 71, // ERR_ITEM_MAX_COUNT_SOCKETED
113 EQUIP_ERR_MAIL_BOUND_ITEM
= 72, // ERR_MAIL_BOUND_ITEM
114 EQUIP_ERR_NO_SPLIT_WHILE_PROSPECTING
= 73, // ERR_INTERNAL_BAG_ERROR
115 EQUIP_ERR_BAG_FULL7
= 74, // ERR_BAG_FULL
116 EQUIP_ERR_ITEM_MAX_COUNT_EQUIPPED_SOCKETED
= 75, // ERR_ITEM_MAX_COUNT_EQUIPPED_SOCKETED
117 EQUIP_ERR_ITEM_UNIQUE_EQUIPPABLE_SOCKETED
= 76, // ERR_ITEM_UNIQUE_EQUIPPABLE_SOCKETED
118 EQUIP_ERR_TOO_MUCH_GOLD
= 77, // ERR_TOO_MUCH_GOLD
119 EQUIP_ERR_NOT_DURING_ARENA_MATCH
= 78, // ERR_NOT_DURING_ARENA_MATCH
120 EQUIP_ERR_CANNOT_TRADE_THAT
= 79, // ERR_TRADE_BOUND_ITEM
121 EQUIP_ERR_PERSONAL_ARENA_RATING_TOO_LOW
= 80, // ERR_CANT_EQUIP_RATING
122 EQUIP_ERR_EVENT_AUTOEQUIP_BIND_CONFIRM
= 81, // EQUIP_ERR_OK, EVENT_AUTOEQUIP_BIND_CONFIRM
123 EQUIP_ERR_ARTEFACTS_ONLY_FOR_OWN_CHARACTERS
= 82, // ERR_NOT_SAME_ACCOUNT
124 EQUIP_ERR_OK2
= 83, // EQUIP_ERR_OK
125 EQUIP_ERR_ITEM_MAX_LIMIT_CATEGORY_COUNT_EXCEEDED_IS
= 84,
126 EQUIP_ERR_ITEM_MAX_LIMIT_CATEGORY_SOCKETED_EXCEEDED_IS
= 85,
127 EQUIP_ERR_SCALING_STAT_ITEM_LEVEL_EXCEEDED
= 86,
128 EQUIP_ERR_PURCHASE_LEVEL_TOO_LOW
= 87,
129 EQUIP_ERR_CANT_EQUIP_NEED_TALENT
= 88,
130 EQUIP_ERR_ITEM_MAX_LIMIT_CATEGORY_EQUIPPED_EXCEEDED_IS
= 89
135 BUY_ERR_CANT_FIND_ITEM
= 0,
136 BUY_ERR_ITEM_ALREADY_SOLD
= 1,
137 BUY_ERR_NOT_ENOUGHT_MONEY
= 2,
138 BUY_ERR_SELLER_DONT_LIKE_YOU
= 4,
139 BUY_ERR_DISTANCE_TOO_FAR
= 5,
140 BUY_ERR_ITEM_SOLD_OUT
= 7,
141 BUY_ERR_CANT_CARRY_MORE
= 8,
142 BUY_ERR_RANK_REQUIRE
= 11,
143 BUY_ERR_REPUTATION_REQUIRE
= 12
148 SELL_ERR_CANT_FIND_ITEM
= 1,
149 SELL_ERR_CANT_SELL_ITEM
= 2, // merchant doesn't like that item
150 SELL_ERR_CANT_FIND_VENDOR
= 3, // merchant doesn't like you
151 SELL_ERR_YOU_DONT_OWN_THAT_ITEM
= 4, // you don't own that item
152 SELL_ERR_UNK
= 5, // nothing appears...
153 SELL_ERR_ONLY_EMPTY_BAG
= 6 // can only do with empty bags
156 // -1 from client enchantment slot number
159 PERM_ENCHANTMENT_SLOT
= 0,
160 TEMP_ENCHANTMENT_SLOT
= 1,
161 SOCK_ENCHANTMENT_SLOT
= 2,
162 SOCK_ENCHANTMENT_SLOT_2
= 3,
163 SOCK_ENCHANTMENT_SLOT_3
= 4,
164 BONUS_ENCHANTMENT_SLOT
= 5,
165 PRISMATIC_ENCHANTMENT_SLOT
= 6, // added at apply special permanent enchantment
166 MAX_INSPECTED_ENCHANTMENT_SLOT
= 7,
168 PROP_ENCHANTMENT_SLOT_0
= 7, // used with RandomSuffix
169 PROP_ENCHANTMENT_SLOT_1
= 8, // used with RandomSuffix
170 PROP_ENCHANTMENT_SLOT_2
= 9, // used with RandomSuffix and RandomProperty
171 PROP_ENCHANTMENT_SLOT_3
= 10, // used with RandomProperty
172 PROP_ENCHANTMENT_SLOT_4
= 11, // used with RandomProperty
173 MAX_ENCHANTMENT_SLOT
= 12
176 #define MAX_VISIBLE_ITEM_OFFSET 2 // 2 fields per visible item (entry+enchantment)
178 #define MAX_GEM_SOCKETS MAX_ITEM_PROTO_SOCKETS// (BONUS_ENCHANTMENT_SLOT-SOCK_ENCHANTMENT_SLOT) and item proto size, equal value expected
180 enum EnchantmentOffset
182 ENCHANTMENT_ID_OFFSET
= 0,
183 ENCHANTMENT_DURATION_OFFSET
= 1,
184 ENCHANTMENT_CHARGES_OFFSET
= 2 // now here not only charges, but something new in wotlk
187 #define MAX_ENCHANTMENT_OFFSET 3
189 enum EnchantmentSlotMask
191 ENCHANTMENT_CAN_SOULBOUND
= 0x01,
192 ENCHANTMENT_UNK1
= 0x02,
193 ENCHANTMENT_UNK2
= 0x04,
194 ENCHANTMENT_UNK3
= 0x08
205 enum ItemRequiredTargetType
207 ITEM_TARGET_TYPE_CREATURE
= 1,
208 ITEM_TARGET_TYPE_DEAD
= 2
211 #define MAX_ITEM_REQ_TARGET_TYPE 2
213 struct ItemRequiredTarget
215 ItemRequiredTarget(ItemRequiredTargetType uiType
, uint32 uiTargetEntry
) : m_uiType(uiType
), m_uiTargetEntry(uiTargetEntry
) {}
216 ItemRequiredTargetType m_uiType
;
217 uint32 m_uiTargetEntry
;
220 bool IsFitToRequirements(Unit
* pUnitTarget
) const;
223 bool ItemCanGoIntoBag(ItemPrototype
const *proto
, ItemPrototype
const *pBagProto
);
225 class MANGOS_DLL_SPEC Item
: public Object
228 static Item
* CreateItem( uint32 item
, uint32 count
, Player
const* player
= NULL
);
229 Item
* CloneItem( uint32 count
, Player
const* player
= NULL
) const;
233 virtual bool Create( uint32 guidlow
, uint32 itemid
, Player
const* owner
);
235 ItemPrototype
const* GetProto() const;
237 uint64
const& GetOwnerGUID() const { return GetUInt64Value(ITEM_FIELD_OWNER
); }
238 void SetOwnerGUID(uint64 guid
) { SetUInt64Value(ITEM_FIELD_OWNER
, guid
); }
239 Player
* GetOwner()const;
241 void SetBinding(bool val
) { ApplyModFlag(ITEM_FIELD_FLAGS
,ITEM_FLAGS_BINDED
,val
); }
242 bool IsSoulBound() const { return HasFlag(ITEM_FIELD_FLAGS
, ITEM_FLAGS_BINDED
); }
243 bool IsBoundAccountWide() const { return HasFlag(ITEM_FIELD_FLAGS
, ITEM_FLAGS_BOA
); }
244 bool IsBindedNotWith(Player
const* player
) const;
245 bool IsBoundByEnchant() const;
246 virtual void SaveToDB();
247 virtual bool LoadFromDB(uint32 guid
, uint64 owner_guid
, QueryResult
*result
= NULL
);
248 virtual void DeleteFromDB();
249 void DeleteFromInventoryDB();
251 bool IsBag() const { return GetProto()->InventoryType
== INVTYPE_BAG
; }
252 bool IsBroken() const { return GetUInt32Value(ITEM_FIELD_MAXDURABILITY
) > 0 && GetUInt32Value(ITEM_FIELD_DURABILITY
) == 0; }
253 bool CanBeTraded(bool mail
= false) const;
254 void SetInTrade(bool b
= true) { mb_in_trade
= b
; }
255 bool IsInTrade() const { return mb_in_trade
; }
257 bool IsFitToSpellRequirements(SpellEntry
const* spellInfo
) const;
258 bool IsTargetValidForItemUse(Unit
* pUnitTarget
);
259 bool IsLimitedToAnotherMapOrZone( uint32 cur_mapId
, uint32 cur_zoneId
) const;
260 bool GemsFitSockets() const;
262 uint32
GetCount() const { return GetUInt32Value (ITEM_FIELD_STACK_COUNT
); }
263 void SetCount(uint32 value
) { SetUInt32Value (ITEM_FIELD_STACK_COUNT
, value
); }
264 uint32
GetMaxStackCount() const { return GetProto()->GetMaxStackSize(); }
265 uint8
GetGemCountWithID(uint32 GemID
) const;
266 uint8
GetGemCountWithLimitCategory(uint32 limitCategory
) const;
267 uint8
CanBeMergedPartlyWith(ItemPrototype
const* proto
) const;
269 uint8
GetSlot() const {return m_slot
;}
270 Bag
*GetContainer() { return m_container
; }
271 uint8
GetBagSlot() const;
272 void SetSlot(uint8 slot
) {m_slot
= slot
;}
273 uint16
GetPos() const { return uint16(GetBagSlot()) << 8 | GetSlot(); }
274 void SetContainer(Bag
*container
) { m_container
= container
; }
276 bool IsInBag() const { return m_container
!= NULL
; }
277 bool IsEquipped() const;
282 // RandomPropertyId (signed but stored as unsigned)
283 int32
GetItemRandomPropertyId() const { return GetInt32Value(ITEM_FIELD_RANDOM_PROPERTIES_ID
); }
284 uint32
GetItemSuffixFactor() const { return GetUInt32Value(ITEM_FIELD_PROPERTY_SEED
); }
285 void SetItemRandomProperties(int32 randomPropId
);
286 bool UpdateItemSuffixFactor();
287 static int32
GenerateItemRandomPropertyId(uint32 item_id
);
288 void SetEnchantment(EnchantmentSlot slot
, uint32 id
, uint32 duration
, uint32 charges
);
289 void SetEnchantmentDuration(EnchantmentSlot slot
, uint32 duration
);
290 void SetEnchantmentCharges(EnchantmentSlot slot
, uint32 charges
);
291 void ClearEnchantment(EnchantmentSlot slot
);
292 uint32
GetEnchantmentId(EnchantmentSlot slot
) const { return GetUInt32Value(ITEM_FIELD_ENCHANTMENT_1_1
+ slot
*MAX_ENCHANTMENT_OFFSET
+ ENCHANTMENT_ID_OFFSET
);}
293 uint32
GetEnchantmentDuration(EnchantmentSlot slot
) const { return GetUInt32Value(ITEM_FIELD_ENCHANTMENT_1_1
+ slot
*MAX_ENCHANTMENT_OFFSET
+ ENCHANTMENT_DURATION_OFFSET
);}
294 uint32
GetEnchantmentCharges(EnchantmentSlot slot
) const { return GetUInt32Value(ITEM_FIELD_ENCHANTMENT_1_1
+ slot
*MAX_ENCHANTMENT_OFFSET
+ ENCHANTMENT_CHARGES_OFFSET
);}
296 void SendTimeUpdate(Player
* owner
);
297 void UpdateDuration(Player
* owner
, uint32 diff
);
299 // spell charges (signed but stored as unsigned)
300 int32
GetSpellCharges(uint8 index
/*0..5*/ = 0) const { return GetInt32Value(ITEM_FIELD_SPELL_CHARGES
+ index
); }
301 void SetSpellCharges(uint8 index
/*0..5*/, int32 value
) { SetInt32Value(ITEM_FIELD_SPELL_CHARGES
+ index
,value
); }
304 bool m_lootGenerated
;
307 ItemUpdateState
GetState() const { return uState
; }
308 void SetState(ItemUpdateState state
, Player
*forplayer
= NULL
);
309 void AddToUpdateQueueOf(Player
*player
);
310 void RemoveFromUpdateQueueOf(Player
*player
);
311 bool IsInUpdateQueue() const { return uQueuePos
!= -1; }
312 uint16
GetQueuePos() const { return uQueuePos
; }
313 void FSetState(ItemUpdateState state
) // forced
318 bool hasQuest(uint32 quest_id
) const { return GetProto()->StartQuest
== quest_id
; }
319 bool hasInvolvedQuest(uint32
/*quest_id*/) const { return false; }
320 bool IsPotion() const { return GetProto()->IsPotion(); }
321 bool IsConjuredConsumable() const { return GetProto()->IsConjuredConsumable(); }
323 void AddToClientUpdateList();
324 void RemoveFromClientUpdateList();
325 void BuildUpdateData(UpdateDataMapType
& update_players
);
329 ItemUpdateState uState
;
331 bool mb_in_trade
; // true if item is currently in trade-window