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_QUEST_H
20 #define MANGOSSERVER_QUEST_H
22 #include "Platform/Define.h"
23 #include "Database/DatabaseEnv.h"
32 #define MAX_QUEST_LOG_SIZE 25
34 #define QUEST_OBJECTIVES_COUNT 4
35 #define QUEST_ITEM_OBJECTIVES_COUNT 6
36 #define QUEST_SOURCE_ITEM_IDS_COUNT 4
37 #define QUEST_REWARD_CHOICES_COUNT 6
38 #define QUEST_REWARDS_COUNT 4
39 #define QUEST_DEPLINK_COUNT 10
40 #define QUEST_REPUTATIONS_COUNT 5
41 #define QUEST_EMOTE_COUNT 4
43 enum QuestFailedReasons
45 INVALIDREASON_DONT_HAVE_REQ
= 0,
46 INVALIDREASON_QUEST_FAILED_LOW_LEVEL
= 1, // You are not high enough level for that quest.
47 INVALIDREASON_QUEST_FAILED_WRONG_RACE
= 6, // That quest is not available to your race.
48 INVALIDREASON_QUEST_ALREADY_DONE
= 7, // You have completed that quest.
49 INVALIDREASON_QUEST_ONLY_ONE_TIMED
= 12, // You can only be on one timed quest at a time.
50 INVALIDREASON_QUEST_ALREADY_ON
= 13, // You are already on that quest.
51 INVALIDREASON_QUEST_FAILED_EXPANSION
= 16, // This quest requires an expansion enabled account.
52 INVALIDREASON_QUEST_ALREADY_ON2
= 18, // You are already on that quest.
53 INVALIDREASON_QUEST_FAILED_MISSING_ITEMS
= 21, // You don't have the required items with you. Check storage.
54 INVALIDREASON_QUEST_FAILED_NOT_ENOUGH_MONEY
= 23, // You don't have enough money for that quest.
55 INVALIDREASON_DAILY_QUESTS_REMAINING
= 26, // You have already completed 25 daily quests today.
56 INVALIDREASON_QUEST_FAILED_CAIS
= 27, // You cannot complete quests once you have reached tired time.
57 INVALIDREASON_DAILY_QUEST_COMPLETED_TODAY
= 29 // You have completed that daily quest today.
60 enum QuestShareMessages
62 QUEST_PARTY_MSG_SHARING_QUEST
= 0, // ERR_QUEST_PUSH_SUCCESS_S
63 QUEST_PARTY_MSG_CANT_TAKE_QUEST
= 1, // ERR_QUEST_PUSH_INVALID_S
64 QUEST_PARTY_MSG_ACCEPT_QUEST
= 2, // ERR_QUEST_PUSH_ACCEPTED_S
65 QUEST_PARTY_MSG_DECLINE_QUEST
= 3, // ERR_QUEST_PUSH_DECLINED_S
66 QUEST_PARTY_MSG_BUSY
= 4, // ERR_QUEST_PUSH_BUSY_S
67 QUEST_PARTY_MSG_LOG_FULL
= 5, // ERR_QUEST_PUSH_LOG_FULL_S
68 QUEST_PARTY_MSG_HAVE_QUEST
= 6, // ERR_QUEST_PUSH_ONQUEST_S
69 QUEST_PARTY_MSG_FINISH_QUEST
= 7, // ERR_QUEST_PUSH_ALREADY_DONE_S
70 QUEST_PARTY_MSG_CANT_BE_SHARED_TODAY
= 8, // ERR_QUEST_PUSH_NOT_DAILY_S
71 QUEST_PARTY_MSG_SHARING_TIMER_EXPIRED
= 9, // ERR_QUEST_PUSH_TIMER_EXPIRED_S
72 QUEST_PARTY_MSG_NOT_IN_PARTY
= 10, // ERR_QUEST_PUSH_NOT_IN_PARTY_S
73 QUESY_PARTY_MSG_DIFFERENT_SERVER_DAILY
= 11 // ERR_QUEST_PUSH_DIFFERENT_SERVER_DAILY_S
76 enum __QuestTradeSkill
78 QUEST_TRSKILL_NONE
= 0,
79 QUEST_TRSKILL_ALCHEMY
= 1,
80 QUEST_TRSKILL_BLACKSMITHING
= 2,
81 QUEST_TRSKILL_COOKING
= 3,
82 QUEST_TRSKILL_ENCHANTING
= 4,
83 QUEST_TRSKILL_ENGINEERING
= 5,
84 QUEST_TRSKILL_FIRSTAID
= 6,
85 QUEST_TRSKILL_HERBALISM
= 7,
86 QUEST_TRSKILL_LEATHERWORKING
= 8,
87 QUEST_TRSKILL_POISONS
= 9,
88 QUEST_TRSKILL_TAILORING
= 10,
89 QUEST_TRSKILL_MINING
= 11,
90 QUEST_TRSKILL_FISHING
= 12,
91 QUEST_TRSKILL_SKINNING
= 13,
92 QUEST_TRSKILL_JEWELCRAFTING
= 14,
97 QUEST_STATUS_NONE
= 0,
98 QUEST_STATUS_COMPLETE
= 1,
99 QUEST_STATUS_UNAVAILABLE
= 2,
100 QUEST_STATUS_INCOMPLETE
= 3,
101 QUEST_STATUS_AVAILABLE
= 4,
102 QUEST_STATUS_FAILED
= 5,
106 enum __QuestGiverStatus
108 DIALOG_STATUS_NONE
= 0,
109 DIALOG_STATUS_UNAVAILABLE
= 1,
110 DIALOG_STATUS_CHAT
= 2, // 3.1 - may be changed
111 DIALOG_STATUS_UNK1
= 3, // 3.1
112 DIALOG_STATUS_UNK2
= 4, // 3.1
113 DIALOG_STATUS_INCOMPLETE
= 5,
114 DIALOG_STATUS_REWARD_REP
= 6,
115 DIALOG_STATUS_AVAILABLE_REP
= 7,
116 DIALOG_STATUS_AVAILABLE
= 8,
117 DIALOG_STATUS_REWARD2
= 9, // no yellow dot on minimap
118 DIALOG_STATUS_REWARD
= 10 // yellow dot on minimap
123 // Flags used at server and sent to client
124 QUEST_FLAGS_STAY_ALIVE
= 0x00000001, // Not used currently
125 QUEST_FLAGS_PARTY_ACCEPT
= 0x00000002, // If player in party, all players that can accept this quest will receive confirmation box to accept quest CMSG_QUEST_CONFIRM_ACCEPT/SMSG_QUEST_CONFIRM_ACCEPT
126 QUEST_FLAGS_EXPLORATION
= 0x00000004, // Not used currently
127 QUEST_FLAGS_SHARABLE
= 0x00000008, // Can be shared: Player::CanShareQuest()
128 //QUEST_FLAGS_NONE2 = 0x00000010, // Not used currently
129 QUEST_FLAGS_EPIC
= 0x00000020, // Not used currently - 1 quest in 3.3
130 QUEST_FLAGS_RAID
= 0x00000040, // Not used currently
131 QUEST_FLAGS_TBC
= 0x00000080, // Not used currently: Available if TBC expansion enabled only
132 QUEST_FLAGS_UNK2
= 0x00000100, // Not used currently: _DELIVER_MORE Quest needs more than normal _q-item_ drops from mobs
133 QUEST_FLAGS_HIDDEN_REWARDS
= 0x00000200, // Items and money rewarded only sent in SMSG_QUESTGIVER_OFFER_REWARD (not in SMSG_QUESTGIVER_QUEST_DETAILS or in client quest log(SMSG_QUEST_QUERY_RESPONSE))
134 QUEST_FLAGS_AUTO_REWARDED
= 0x00000400, // These quests are automatically rewarded on quest complete and they will never appear in quest log client side.
135 QUEST_FLAGS_TBC_RACES
= 0x00000800, // Not used currently: Blood elf/Draenei starting zone quests
136 QUEST_FLAGS_DAILY
= 0x00001000, // Used to know quest is Daily one
137 QUEST_FLAGS_UNK3
= 0x00002000, // activates PvP?
138 QUEST_FLAGS_UNK4
= 0x00004000, // ? Membership Card Renewal
139 QUEST_FLAGS_WEEKLY
= 0x00008000, // Not used currently: Weekly quests
140 // 0x20000 - 1 quest in 3.3, 0x40000 - 1 quest in 3.3
141 QUEST_FLAGS_LOW_LEVEL
= 0x00080000, // quests in starting areas
143 // Mangos flags for set SpecialFlags in DB if required but used only at server
144 QUEST_MANGOS_FLAGS_REPEATABLE
= 0x01000000, // Set by 1 in SpecialFlags from DB
145 QUEST_MANGOS_FLAGS_EXPLORATION_OR_EVENT
= 0x02000000, // Set by 2 in SpecialFlags from DB (if required area explore, spell SPELL_EFFECT_QUEST_COMPLETE casting, table `*_script` command SCRIPT_COMMAND_QUEST_EXPLORED use, set from script DLL)
146 QUEST_MANGOS_FLAGS_DB_ALLOWED
= 0xFFFFFF | QUEST_MANGOS_FLAGS_REPEATABLE
| QUEST_MANGOS_FLAGS_EXPLORATION_OR_EVENT
,
148 // Mangos flags for internal use only
149 QUEST_MANGOS_FLAGS_DELIVER
= 0x04000000, // Internal flag computed only
150 QUEST_MANGOS_FLAGS_SPEAKTO
= 0x08000000, // Internal flag computed only
151 QUEST_MANGOS_FLAGS_KILL_OR_CAST
= 0x10000000, // Internal flag computed only
152 QUEST_MANGOS_FLAGS_TIMED
= 0x20000000, // Internal flag computed only
157 QuestLocale() { ObjectiveText
.resize(QUEST_OBJECTIVES_COUNT
); }
159 std::vector
<std::string
> Title
;
160 std::vector
<std::string
> Details
;
161 std::vector
<std::string
> Objectives
;
162 std::vector
<std::string
> OfferRewardText
;
163 std::vector
<std::string
> RequestItemsText
;
164 std::vector
<std::string
> EndText
;
165 std::vector
< std::vector
<std::string
> > ObjectiveText
;
168 // This Quest class provides a convenient way to access a few pretotaled (cached) quest details,
169 // all base quest information, and any utility functions such as generating the amount of
173 friend class ObjectMgr
;
175 Quest(Field
* questRecord
);
176 uint32
XPValue( Player
*pPlayer
) const;
178 bool HasFlag( uint32 flag
) const { return ( QuestFlags
& flag
) != 0; }
179 void SetFlag( uint32 flag
) { QuestFlags
|= flag
; }
181 // table data accessors:
182 uint32
GetQuestId() const { return QuestId
; }
183 uint32
GetQuestMethod() const { return QuestMethod
; }
184 int32
GetZoneOrSort() const { return ZoneOrSort
; }
185 int32
GetSkillOrClass() const { return SkillOrClass
; }
186 uint32
GetMinLevel() const { return MinLevel
; }
187 int32
GetQuestLevel() const { return QuestLevel
; }
188 uint32
GetType() const { return Type
; }
189 uint32
GetRequiredRaces() const { return RequiredRaces
; }
190 uint32
GetRequiredSkillValue() const { return RequiredSkillValue
; }
191 uint32
GetRepObjectiveFaction() const { return RepObjectiveFaction
; }
192 int32
GetRepObjectiveValue() const { return RepObjectiveValue
; }
193 uint32
GetRequiredMinRepFaction() const { return RequiredMinRepFaction
; }
194 int32
GetRequiredMinRepValue() const { return RequiredMinRepValue
; }
195 uint32
GetRequiredMaxRepFaction() const { return RequiredMaxRepFaction
; }
196 int32
GetRequiredMaxRepValue() const { return RequiredMaxRepValue
; }
197 uint32
GetSuggestedPlayers() const { return SuggestedPlayers
; }
198 uint32
GetLimitTime() const { return LimitTime
; }
199 int32
GetPrevQuestId() const { return PrevQuestId
; }
200 int32
GetNextQuestId() const { return NextQuestId
; }
201 int32
GetExclusiveGroup() const { return ExclusiveGroup
; }
202 uint32
GetNextQuestInChain() const { return NextQuestInChain
; }
203 uint32
GetCharTitleId() const { return CharTitleId
; }
204 uint32
GetPlayersSlain() const { return PlayersSlain
; }
205 uint32
GetBonusTalents() const { return BonusTalents
; }
206 uint32
GetSrcItemId() const { return SrcItemId
; }
207 uint32
GetSrcItemCount() const { return SrcItemCount
; }
208 uint32
GetSrcSpell() const { return SrcSpell
; }
209 std::string
GetTitle() const { return Title
; }
210 std::string
GetDetails() const { return Details
; }
211 std::string
GetObjectives() const { return Objectives
; }
212 std::string
GetOfferRewardText() const { return OfferRewardText
; }
213 std::string
GetRequestItemsText() const { return RequestItemsText
; }
214 std::string
GetEndText() const { return EndText
; }
215 int32
GetRewOrReqMoney() const;
216 uint32
GetRewHonorableKills() const { return RewHonorableKills
; }
217 uint32
GetRewMoneyMaxLevel() const { return RewMoneyMaxLevel
; }
218 // use in XP calculation at client
219 uint32
GetRewSpell() const { return RewSpell
; }
220 uint32
GetRewSpellCast() const { return RewSpellCast
; }
221 uint32
GetRewMailTemplateId() const { return RewMailTemplateId
; }
222 uint32
GetRewMailDelaySecs() const { return RewMailDelaySecs
; }
223 uint32
GetPointMapId() const { return PointMapId
; }
224 float GetPointX() const { return PointX
; }
225 float GetPointY() const { return PointY
; }
226 uint32
GetPointOpt() const { return PointOpt
; }
227 uint32
GetIncompleteEmote() const { return IncompleteEmote
; }
228 uint32
GetCompleteEmote() const { return CompleteEmote
; }
229 uint32
GetQuestStartScript() const { return QuestStartScript
; }
230 uint32
GetQuestCompleteScript() const { return QuestCompleteScript
; }
231 bool IsRepeatable() const { return QuestFlags
& QUEST_MANGOS_FLAGS_REPEATABLE
; }
232 bool IsAutoComplete() const { return QuestMethod
? false : true; }
233 uint32
GetFlags() const { return QuestFlags
; }
234 bool IsDaily() const { return QuestFlags
& QUEST_FLAGS_DAILY
; }
237 std::string ObjectiveText
[QUEST_OBJECTIVES_COUNT
];
238 uint32 ReqItemId
[QUEST_ITEM_OBJECTIVES_COUNT
];
239 uint32 ReqItemCount
[QUEST_ITEM_OBJECTIVES_COUNT
];
240 uint32 ReqSourceId
[QUEST_SOURCE_ITEM_IDS_COUNT
];
241 uint32 ReqSourceCount
[QUEST_SOURCE_ITEM_IDS_COUNT
];
242 int32 ReqCreatureOrGOId
[QUEST_OBJECTIVES_COUNT
]; // >0 Creature <0 Gameobject
243 uint32 ReqCreatureOrGOCount
[QUEST_OBJECTIVES_COUNT
];
244 uint32 ReqSpell
[QUEST_OBJECTIVES_COUNT
];
245 uint32 RewChoiceItemId
[QUEST_REWARD_CHOICES_COUNT
];
246 uint32 RewChoiceItemCount
[QUEST_REWARD_CHOICES_COUNT
];
247 uint32 RewItemId
[QUEST_REWARDS_COUNT
];
248 uint32 RewItemCount
[QUEST_REWARDS_COUNT
];
249 uint32 RewRepFaction
[QUEST_REPUTATIONS_COUNT
];
250 int32 RewRepValue
[QUEST_REPUTATIONS_COUNT
];
251 uint32 DetailsEmote
[QUEST_EMOTE_COUNT
];
252 uint32 DetailsEmoteDelay
[QUEST_EMOTE_COUNT
];
253 uint32 OfferRewardEmote
[QUEST_EMOTE_COUNT
];
254 uint32 OfferRewardEmoteDelay
[QUEST_EMOTE_COUNT
];
256 uint32
GetReqItemsCount() const { return m_reqitemscount
; }
257 uint32
GetReqCreatureOrGOcount() const { return m_reqCreatureOrGOcount
; }
258 uint32
GetRewChoiceItemsCount() const { return m_rewchoiceitemscount
; }
259 uint32
GetRewItemsCount() const { return m_rewitemscount
; }
261 typedef std::vector
<int32
> PrevQuests
;
262 PrevQuests prevQuests
;
263 typedef std::vector
<uint32
> PrevChainQuests
;
264 PrevChainQuests prevChainQuests
;
268 uint32 m_reqitemscount
;
269 uint32 m_reqCreatureOrGOcount
;
270 uint32 m_rewchoiceitemscount
;
271 uint32 m_rewitemscount
;
282 uint32 RequiredRaces
;
283 uint32 RequiredSkillValue
;
284 uint32 RepObjectiveFaction
;
285 int32 RepObjectiveValue
;
286 uint32 RequiredMinRepFaction
;
287 int32 RequiredMinRepValue
;
288 uint32 RequiredMaxRepFaction
;
289 int32 RequiredMaxRepValue
;
290 uint32 SuggestedPlayers
;
298 int32 ExclusiveGroup
;
299 uint32 NextQuestInChain
;
305 std::string Objectives
;
306 std::string OfferRewardText
;
307 std::string RequestItemsText
;
309 uint32 RewHonorableKills
;
311 uint32 RewMoneyMaxLevel
;
314 uint32 RewMailTemplateId
;
315 uint32 RewMailDelaySecs
;
320 uint32 IncompleteEmote
;
321 uint32 CompleteEmote
;
322 uint32 QuestStartScript
;
323 uint32 QuestCompleteScript
;
326 enum QuestUpdateState
333 struct QuestStatusData
336 : m_status(QUEST_STATUS_NONE
),m_rewarded(false),
337 m_explored(false), m_timer(0), uState(QUEST_NEW
)
339 memset(m_itemcount
, 0, QUEST_ITEM_OBJECTIVES_COUNT
* sizeof(uint32
));
340 memset(m_creatureOrGOcount
, 0, QUEST_OBJECTIVES_COUNT
* sizeof(uint32
));
343 QuestStatus m_status
;
347 QuestUpdateState uState
;
349 uint32 m_itemcount
[ QUEST_ITEM_OBJECTIVES_COUNT
];
350 uint32 m_creatureOrGOcount
[ QUEST_OBJECTIVES_COUNT
];