src/game/QuestDef.h

   1 /*
   2  * Copyright (C) 2005-2009 MaNGOS <http://getmangos.com/>
   3  *
   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.
   8  *
   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.
  13  *
  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
  17  */
  18
  19 #ifndef MANGOSSERVER_QUEST_H
  20 #define MANGOSSERVER_QUEST_H
  21
  22 #include "Platform/Define.h"
  23 #include "Database/DatabaseEnv.h"
  24
  25 #include <string>
  26 #include <vector>
  27
  28 class Player;
  29
  30 class ObjectMgr;
  31
  32 #define MAX_QUEST_LOG_SIZE 25
  33
  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
  42
  43 enum QuestFailedReasons
  44 {
  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.
  58 };
  59
  60 enum QuestShareMessages
  61 {
  62     QUEST_PARTY_MSG_SHARING_QUEST           = 0,
  63     QUEST_PARTY_MSG_CANT_TAKE_QUEST         = 1,
  64     QUEST_PARTY_MSG_ACCEPT_QUEST            = 2,
  65     QUEST_PARTY_MSG_DECLINE_QUEST           = 3,
  66     QUEST_PARTY_MSG_BUSY                    = 4,
  67     QUEST_PARTY_MSG_LOG_FULL                = 5,
  68     QUEST_PARTY_MSG_HAVE_QUEST              = 6,
  69     QUEST_PARTY_MSG_FINISH_QUEST            = 7,
  70     QUEST_PARTY_MSG_CANT_BE_SHARED_TODAY    = 8,
  71     QUEST_PARTY_MSG_SHARING_TIMER_EXPIRED   = 9,
  72     QUEST_PARTY_MSG_NOT_IN_PARTY            = 10
  73 };
  74
  75 enum __QuestTradeSkill
  76 {
  77     QUEST_TRSKILL_NONE           = 0,
  78     QUEST_TRSKILL_ALCHEMY        = 1,
  79     QUEST_TRSKILL_BLACKSMITHING  = 2,
  80     QUEST_TRSKILL_COOKING        = 3,
  81     QUEST_TRSKILL_ENCHANTING     = 4,
  82     QUEST_TRSKILL_ENGINEERING    = 5,
  83     QUEST_TRSKILL_FIRSTAID       = 6,
  84     QUEST_TRSKILL_HERBALISM      = 7,
  85     QUEST_TRSKILL_LEATHERWORKING = 8,
  86     QUEST_TRSKILL_POISONS        = 9,
  87     QUEST_TRSKILL_TAILORING      = 10,
  88     QUEST_TRSKILL_MINING         = 11,
  89     QUEST_TRSKILL_FISHING        = 12,
  90     QUEST_TRSKILL_SKINNING       = 13,
  91     QUEST_TRSKILL_JEWELCRAFTING  = 14,
  92 };
  93
  94 enum QuestStatus
  95 {
  96     QUEST_STATUS_NONE           = 0,
  97     QUEST_STATUS_COMPLETE       = 1,
  98     QUEST_STATUS_UNAVAILABLE    = 2,
  99     QUEST_STATUS_INCOMPLETE     = 3,
 100     QUEST_STATUS_AVAILABLE      = 4,
 101     QUEST_STATUS_FAILED         = 5,
 102     MAX_QUEST_STATUS
 103 };
 104
 105 enum __QuestGiverStatus
 106 {
 107     DIALOG_STATUS_NONE                     = 0,
 108     DIALOG_STATUS_UNAVAILABLE              = 1,
 109     DIALOG_STATUS_CHAT                     = 2,             // 3.1 - may be changed
 110     DIALOG_STATUS_UNK1                     = 3,             // 3.1
 111     DIALOG_STATUS_UNK2                     = 4,             // 3.1
 112     DIALOG_STATUS_INCOMPLETE               = 5,
 113     DIALOG_STATUS_REWARD_REP               = 6,
 114     DIALOG_STATUS_AVAILABLE_REP            = 7,
 115     DIALOG_STATUS_AVAILABLE                = 8,
 116     DIALOG_STATUS_REWARD2                  = 9,             // no yellow dot on minimap
 117     DIALOG_STATUS_REWARD                   = 10             // yellow dot on minimap
 118 };
 119
 120 enum __QuestFlags
 121 {
 122     // Flags used at server and sent to client
 123     QUEST_FLAGS_STAY_ALIVE     = 0x00000001,                // Not used currently
 124     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
 125     QUEST_FLAGS_EXPLORATION    = 0x00000004,                // Not used currently
 126     QUEST_FLAGS_SHARABLE       = 0x00000008,                // Can be shared: Player::CanShareQuest()
 127     //QUEST_FLAGS_NONE2        = 0x00000010,                // Not used currently
 128     QUEST_FLAGS_EPIC           = 0x00000020,                // Not used currently: Unsure of content
 129     QUEST_FLAGS_RAID           = 0x00000040,                // Not used currently
 130     QUEST_FLAGS_TBC            = 0x00000080,                // Not used currently: Available if TBC expansion enabled only
 131     QUEST_FLAGS_UNK2           = 0x00000100,                // Not used currently: _DELIVER_MORE Quest needs more than normal _q-item_ drops from mobs
 132     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))
 133     QUEST_FLAGS_AUTO_REWARDED  = 0x00000400,                // These quests are automatically rewarded on quest complete and they will never appear in quest log client side.
 134     QUEST_FLAGS_TBC_RACES      = 0x00000800,                // Not used currently: Blood elf/Draenei starting zone quests
 135     QUEST_FLAGS_DAILY          = 0x00001000,                // Used to know quest is Daily one
 136     QUEST_FLAGS_UNK3           = 0x00002000,
 137     QUEST_FLAGS_UNK4           = 0x00004000,                // ? Membership Card Renewal
 138     QUEST_FLAGS_WEEKLY         = 0x00008000,                // Not used currently: Weekly quests
 139
 140     // Mangos flags for set SpecialFlags in DB if required but used only at server
 141     QUEST_MANGOS_FLAGS_REPEATABLE           = 0x010000,     // Set by 1 in SpecialFlags from DB
 142     QUEST_MANGOS_FLAGS_EXPLORATION_OR_EVENT = 0x020000,     // 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)
 143     QUEST_MANGOS_FLAGS_DB_ALLOWED = 0xFFFF | QUEST_MANGOS_FLAGS_REPEATABLE | QUEST_MANGOS_FLAGS_EXPLORATION_OR_EVENT,
 144
 145     // Mangos flags for internal use only
 146     QUEST_MANGOS_FLAGS_DELIVER              = 0x040000,     // Internal flag computed only
 147     QUEST_MANGOS_FLAGS_SPEAKTO              = 0x080000,     // Internal flag computed only
 148     QUEST_MANGOS_FLAGS_KILL_OR_CAST         = 0x100000,     // Internal flag computed only
 149     QUEST_MANGOS_FLAGS_TIMED                = 0x200000,     // Internal flag computed only
 150 };
 151
 152 struct QuestLocale
 153 {
 154     QuestLocale() { ObjectiveText.resize(QUEST_OBJECTIVES_COUNT); }
 155
 156     std::vector<std::string> Title;
 157     std::vector<std::string> Details;
 158     std::vector<std::string> Objectives;
 159     std::vector<std::string> OfferRewardText;
 160     std::vector<std::string> RequestItemsText;
 161     std::vector<std::string> EndText;
 162     std::vector< std::vector<std::string> > ObjectiveText;
 163 };
 164
 165 // This Quest class provides a convenient way to access a few pretotaled (cached) quest details,
 166 // all base quest information, and any utility functions such as generating the amount of
 167 // xp to give
 168 class Quest
 169 {
 170     friend class ObjectMgr;
 171     public:
 172         Quest(Field * questRecord);
 173         uint32 XPValue( Player *pPlayer ) const;
 174
 175         bool HasFlag( uint32 flag ) const { return ( QuestFlags & flag ) != 0; }
 176         void SetFlag( uint32 flag ) { QuestFlags |= flag; }
 177
 178         // table data accessors:
 179         uint32 GetQuestId() const { return QuestId; }
 180         uint32 GetQuestMethod() const { return QuestMethod; }
 181         int32  GetZoneOrSort() const { return ZoneOrSort; }
 182         int32  GetSkillOrClass() const { return SkillOrClass; }
 183         uint32 GetMinLevel() const { return MinLevel; }
 184         int32  GetQuestLevel() const { return QuestLevel; }
 185         uint32 GetType() const { return Type; }
 186         uint32 GetRequiredRaces() const { return RequiredRaces; }
 187         uint32 GetRequiredSkillValue() const { return RequiredSkillValue; }
 188         uint32 GetRepObjectiveFaction() const { return RepObjectiveFaction; }
 189         int32  GetRepObjectiveValue() const { return RepObjectiveValue; }
 190         uint32 GetRequiredMinRepFaction() const { return RequiredMinRepFaction; }
 191         int32  GetRequiredMinRepValue() const { return RequiredMinRepValue; }
 192         uint32 GetRequiredMaxRepFaction() const { return RequiredMaxRepFaction; }
 193         int32  GetRequiredMaxRepValue() const { return RequiredMaxRepValue; }
 194         uint32 GetSuggestedPlayers() const { return SuggestedPlayers; }
 195         uint32 GetLimitTime() const { return LimitTime; }
 196         int32  GetPrevQuestId() const { return PrevQuestId; }
 197         int32  GetNextQuestId() const { return NextQuestId; }
 198         int32  GetExclusiveGroup() const { return ExclusiveGroup; }
 199         uint32 GetNextQuestInChain() const { return NextQuestInChain; }
 200         uint32 GetCharTitleId() const { return CharTitleId; }
 201         uint32 GetPlayersSlain() const { return PlayersSlain; }
 202         uint32 GetBonusTalents() const { return BonusTalents; }
 203         uint32 GetSrcItemId() const { return SrcItemId; }
 204         uint32 GetSrcItemCount() const { return SrcItemCount; }
 205         uint32 GetSrcSpell() const { return SrcSpell; }
 206         std::string GetTitle() const { return Title; }
 207         std::string GetDetails() const { return Details; }
 208         std::string GetObjectives() const { return Objectives; }
 209         std::string GetOfferRewardText() const { return OfferRewardText; }
 210         std::string GetRequestItemsText() const { return RequestItemsText; }
 211         std::string GetEndText() const { return EndText; }
 212         int32  GetRewOrReqMoney() const;
 213         uint32 GetRewHonorableKills() const { return RewHonorableKills; }
 214         uint32 GetRewMoneyMaxLevel() const { return RewMoneyMaxLevel; }
 215                                                             // use in XP calculation at client
 216         uint32 GetRewSpell() const { return RewSpell; }
 217         uint32 GetRewSpellCast() const { return RewSpellCast; }
 218         uint32 GetRewMailTemplateId() const { return RewMailTemplateId; }
 219         uint32 GetRewMailDelaySecs() const { return RewMailDelaySecs; }
 220         uint32 GetPointMapId() const { return PointMapId; }
 221         float  GetPointX() const { return PointX; }
 222         float  GetPointY() const { return PointY; }
 223         uint32 GetPointOpt() const { return PointOpt; }
 224         uint32 GetIncompleteEmote() const { return IncompleteEmote; }
 225         uint32 GetCompleteEmote() const { return CompleteEmote; }
 226         uint32 GetQuestStartScript() const { return QuestStartScript; }
 227         uint32 GetQuestCompleteScript() const { return QuestCompleteScript; }
 228         bool   IsRepeatable() const { return QuestFlags & QUEST_MANGOS_FLAGS_REPEATABLE; }
 229         bool   IsAutoComplete() const { return QuestMethod ? false : true; }
 230         uint32 GetFlags() const { return QuestFlags; }
 231         bool   IsDaily() const { return QuestFlags & QUEST_FLAGS_DAILY; }
 232
 233         // multiple values
 234         std::string ObjectiveText[QUEST_OBJECTIVES_COUNT];
 235         uint32 ReqItemId[QUEST_ITEM_OBJECTIVES_COUNT];
 236         uint32 ReqItemCount[QUEST_ITEM_OBJECTIVES_COUNT];
 237         uint32 ReqSourceId[QUEST_SOURCE_ITEM_IDS_COUNT];
 238         uint32 ReqSourceCount[QUEST_SOURCE_ITEM_IDS_COUNT];
 239         int32  ReqCreatureOrGOId[QUEST_OBJECTIVES_COUNT];   // >0 Creature <0 Gameobject
 240         uint32 ReqCreatureOrGOCount[QUEST_OBJECTIVES_COUNT];
 241         uint32 ReqSpell[QUEST_OBJECTIVES_COUNT];
 242         uint32 RewChoiceItemId[QUEST_REWARD_CHOICES_COUNT];
 243         uint32 RewChoiceItemCount[QUEST_REWARD_CHOICES_COUNT];
 244         uint32 RewItemId[QUEST_REWARDS_COUNT];
 245         uint32 RewItemCount[QUEST_REWARDS_COUNT];
 246         uint32 RewRepFaction[QUEST_REPUTATIONS_COUNT];
 247         int32  RewRepValue[QUEST_REPUTATIONS_COUNT];
 248         uint32 DetailsEmote[QUEST_EMOTE_COUNT];
 249         uint32 DetailsEmoteDelay[QUEST_EMOTE_COUNT];
 250         uint32 OfferRewardEmote[QUEST_EMOTE_COUNT];
 251         uint32 OfferRewardEmoteDelay[QUEST_EMOTE_COUNT];
 252
 253         uint32 GetReqItemsCount() const { return m_reqitemscount; }
 254         uint32 GetReqCreatureOrGOcount() const { return m_reqCreatureOrGOcount; }
 255         uint32 GetRewChoiceItemsCount() const { return m_rewchoiceitemscount; }
 256         uint32 GetRewItemsCount() const { return m_rewitemscount; }
 257
 258         typedef std::vector<int32> PrevQuests;
 259         PrevQuests prevQuests;
 260         typedef std::vector<uint32> PrevChainQuests;
 261         PrevChainQuests prevChainQuests;
 262
 263         // cached data
 264     private:
 265         uint32 m_reqitemscount;
 266         uint32 m_reqCreatureOrGOcount;
 267         uint32 m_rewchoiceitemscount;
 268         uint32 m_rewitemscount;
 269
 270         // table data
 271     protected:
 272         uint32 QuestId;
 273         uint32 QuestMethod;
 274         int32  ZoneOrSort;
 275         int32  SkillOrClass;
 276         uint32 MinLevel;
 277         int32  QuestLevel;
 278         uint32 Type;
 279         uint32 RequiredRaces;
 280         uint32 RequiredSkillValue;
 281         uint32 RepObjectiveFaction;
 282         int32  RepObjectiveValue;
 283         uint32 RequiredMinRepFaction;
 284         int32  RequiredMinRepValue;
 285         uint32 RequiredMaxRepFaction;
 286         int32  RequiredMaxRepValue;
 287         uint32 SuggestedPlayers;
 288         uint32 LimitTime;
 289         uint32 QuestFlags;
 290         uint32 CharTitleId;
 291         uint32 PlayersSlain;
 292         uint32 BonusTalents;
 293         int32  PrevQuestId;
 294         int32  NextQuestId;
 295         int32  ExclusiveGroup;
 296         uint32 NextQuestInChain;
 297         uint32 SrcItemId;
 298         uint32 SrcItemCount;
 299         uint32 SrcSpell;
 300         std::string Title;
 301         std::string Details;
 302         std::string Objectives;
 303         std::string OfferRewardText;
 304         std::string RequestItemsText;
 305         std::string EndText;
 306         uint32 RewHonorableKills;
 307         int32  RewOrReqMoney;
 308         uint32 RewMoneyMaxLevel;
 309         uint32 RewSpell;
 310         uint32 RewSpellCast;
 311         uint32 RewMailTemplateId;
 312         uint32 RewMailDelaySecs;
 313         uint32 PointMapId;
 314         float  PointX;
 315         float  PointY;
 316         uint32 PointOpt;
 317         uint32 IncompleteEmote;
 318         uint32 CompleteEmote;
 319         uint32 QuestStartScript;
 320         uint32 QuestCompleteScript;
 321 };
 322
 323 enum QuestUpdateState
 324 {
 325     QUEST_UNCHANGED = 0,
 326     QUEST_CHANGED = 1,
 327     QUEST_NEW = 2
 328 };
 329
 330 struct QuestStatusData
 331 {
 332     QuestStatusData()
 333         : m_status(QUEST_STATUS_NONE),m_rewarded(false),
 334         m_explored(false), m_timer(0), uState(QUEST_NEW)
 335     {
 336         memset(m_itemcount, 0, QUEST_ITEM_OBJECTIVES_COUNT * sizeof(uint32));
 337         memset(m_creatureOrGOcount, 0, QUEST_OBJECTIVES_COUNT * sizeof(uint32));
 338     }
 339
 340     QuestStatus m_status;
 341     bool m_rewarded;
 342     bool m_explored;
 343     uint32 m_timer;
 344     QuestUpdateState uState;
 345
 346     uint32 m_itemcount[ QUEST_ITEM_OBJECTIVES_COUNT ];
 347     uint32 m_creatureOrGOcount[ QUEST_OBJECTIVES_COUNT ];
 348 };
 349 #endif