src/game/QuestDef.h

   1 /*
   2  * Copyright (C) 2005-2008 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_SOURCE_ITEM_IDS_COUNT 4
  36 #define QUEST_REWARD_CHOICES_COUNT 6
  37 #define QUEST_REWARDS_COUNT 4
  38 #define QUEST_DEPLINK_COUNT 10
  39 #define QUEST_REPUTATIONS_COUNT 5
  40 #define QUEST_EMOTE_COUNT 4
  41
  42 enum QuestFailedReasons
  43 {
  44     INVALIDREASON_DONT_HAVE_REQ                 = 0,
  45     INVALIDREASON_QUEST_FAILED_LOW_LEVEL        = 1,        //You are not high enough level for that quest.
  46     INVALIDREASON_QUEST_FAILED_WRONG_RACE       = 6,        //That quest is not available to your race.
  47     INVALIDREASON_QUEST_ALREADY_DONE            = 7,        //You have completed that quest.
  48     INVALIDREASON_QUEST_ONLY_ONE_TIMED          = 12,       //You can only be on one timed quest at a time.
  49     INVALIDREASON_QUEST_ALREADY_ON              = 13,       //You are already on that quest
  50     INVALIDREASON_QUEST_FAILED_EXPANSION        = 16,       //This quest requires an expansion enabled account.
  51     INVALIDREASON_QUEST_ALREADY_ON2             = 18,       //You are already on that quest
  52     INVALIDREASON_QUEST_FAILED_MISSING_ITEMS    = 21,       //You don't have the required items with you. Check storage.
  53     INVALIDREASON_QUEST_FAILED_NOT_ENOUGH_MONEY = 23,       //You don't have enough money for that quest.
  54     INVALIDREASON_DAILY_QUESTS_REMAINING        = 26,       //You have already completed 10 daily quests today
  55     INVALIDREASON_QUEST_FAILED_CAIS             = 27,       //You cannot complete quests once you have reached tired time
  56 };
  57
  58 enum QuestShareMessages
  59 {
  60     QUEST_PARTY_MSG_SHARING_QUEST   = 0,
  61     QUEST_PARTY_MSG_CANT_TAKE_QUEST = 1,
  62     QUEST_PARTY_MSG_ACCEPT_QUEST    = 2,
  63     QUEST_PARTY_MSG_REFUSE_QUEST    = 3,
  64     QUEST_PARTY_MSG_TOO_FAR         = 4,
  65     QUEST_PARTY_MSG_BUSY            = 5,
  66     QUEST_PARTY_MSG_LOG_FULL        = 6,
  67     QUEST_PARTY_MSG_HAVE_QUEST      = 7,
  68     QUEST_PARTY_MSG_FINISH_QUEST    = 8,
  69 };
  70
  71 enum __QuestTradeSkill
  72 {
  73     QUEST_TRSKILL_NONE           = 0,
  74     QUEST_TRSKILL_ALCHEMY        = 1,
  75     QUEST_TRSKILL_BLACKSMITHING  = 2,
  76     QUEST_TRSKILL_COOKING        = 3,
  77     QUEST_TRSKILL_ENCHANTING     = 4,
  78     QUEST_TRSKILL_ENGINEERING    = 5,
  79     QUEST_TRSKILL_FIRSTAID       = 6,
  80     QUEST_TRSKILL_HERBALISM      = 7,
  81     QUEST_TRSKILL_LEATHERWORKING = 8,
  82     QUEST_TRSKILL_POISONS        = 9,
  83     QUEST_TRSKILL_TAILORING      = 10,
  84     QUEST_TRSKILL_MINING         = 11,
  85     QUEST_TRSKILL_FISHING        = 12,
  86     QUEST_TRSKILL_SKINNING       = 13,
  87     QUEST_TRSKILL_JEWELCRAFTING  = 14,
  88 };
  89
  90 enum QuestStatus
  91 {
  92     QUEST_STATUS_NONE           = 0,
  93     QUEST_STATUS_COMPLETE       = 1,
  94     QUEST_STATUS_UNAVAILABLE    = 2,
  95     QUEST_STATUS_INCOMPLETE     = 3,
  96     QUEST_STATUS_AVAILABLE      = 4,
  97     MAX_QUEST_STATUS
  98 };
  99
 100 enum __QuestGiverStatus
 101 {
 102     DIALOG_STATUS_NONE                     = 0,
 103     DIALOG_STATUS_UNAVAILABLE              = 1,
 104     DIALOG_STATUS_CHAT                     = 2,
 105     DIALOG_STATUS_INCOMPLETE               = 3,
 106     DIALOG_STATUS_REWARD_REP               = 4,
 107     DIALOG_STATUS_AVAILABLE_REP            = 5,
 108     DIALOG_STATUS_AVAILABLE                = 6,
 109     DIALOG_STATUS_REWARD2                  = 7,             // not yellow dot on minimap
 110     DIALOG_STATUS_REWARD                   = 8              // yellow dot on minimap
 111 };
 112
 113 enum __QuestFlags
 114 {
 115     // Flags used at server and sended to client
 116     QUEST_FLAGS_STAY_ALIVE     = 1,                         // Not used currently
 117     QUEST_FLAGS_PARTY_ACCEPT   = 2,                         // Not used currently. 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
 118     QUEST_FLAGS_EXPLORATION    = 4,                         // Not used currently
 119     QUEST_FLAGS_SHARABLE       = 8,                         // Can be shared: Player::CanShareQuest()
 120     //QUEST_FLAGS_NONE2        = 16,                        // Not used currently
 121     QUEST_FLAGS_EPIC           = 32,                        // Not used currently: Unsure of content
 122     QUEST_FLAGS_RAID           = 64,                        // Not used currently
 123     QUEST_FLAGS_TBC            = 128,                       // Not used currently: Available if TBC expension enabled only
 124     QUEST_FLAGS_UNK2           = 256,                       // Not used currently: _DELIVER_MORE Quest needs more than normal _q-item_ drops from mobs
 125     QUEST_FLAGS_HIDDEN_REWARDS = 512,                       // 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))
 126     QUEST_FLAGS_AUTO_REWARDED  = 1024,                      // These quests are automatically rewarded on quest complete and they will never appear in quest log client side.
 127     QUEST_FLAGS_TBC_RACES      = 2048,                      // Not used currently: Bloodelf/draenei starting zone quests
 128     QUEST_FLAGS_DAILY          = 4096,                      // Used to know quest is Daily one
 129
 130     // Mangos flags for set SpecialFlags in DB if required but used only at server
 131     QUEST_MANGOS_FLAGS_REPEATABLE           = 0x010000,     // Set by 1 in SpecialFlags from DB
 132     QUEST_MANGOS_FLAGS_EXPLORATION_OR_EVENT = 0x020000,     // Set by 2 in SpecialFlags from DB (if reequired area explore, spell SPELL_EFFECT_QUEST_COMPLETE casting, table `*_script` command SCRIPT_COMMAND_QUEST_EXPLORED use, set from script DLL)
 133     QUEST_MANGOS_FLAGS_DB_ALLOWED = 0xFFFF | QUEST_MANGOS_FLAGS_REPEATABLE | QUEST_MANGOS_FLAGS_EXPLORATION_OR_EVENT,
 134
 135     // Mangos flags for internal use only
 136     QUEST_MANGOS_FLAGS_DELIVER              = 0x040000,     // Internal flag computed only
 137     QUEST_MANGOS_FLAGS_SPEAKTO              = 0x080000,     // Internal flag computed only
 138     QUEST_MANGOS_FLAGS_KILL_OR_CAST         = 0x100000,     // Internal flag computed only
 139     QUEST_MANGOS_FLAGS_TIMED                = 0x200000,     // Internal flag computed only
 140 };
 141
 142 struct QuestLocale
 143 {
 144     QuestLocale() { ObjectiveText.resize(QUEST_OBJECTIVES_COUNT); }
 145
 146     std::vector<std::string> Title;
 147     std::vector<std::string> Details;
 148     std::vector<std::string> Objectives;
 149     std::vector<std::string> OfferRewardText;
 150     std::vector<std::string> RequestItemsText;
 151     std::vector<std::string> EndText;
 152     std::vector< std::vector<std::string> > ObjectiveText;
 153 };
 154
 155 // This Quest class provides a convenient way to access a few pretotaled (cached) quest details,
 156 // all base quest information, and any utility functions such as generating the amount of
 157 // xp to give
 158 class Quest
 159 {
 160     friend class ObjectMgr;
 161     public:
 162         Quest(Field * questRecord);
 163         uint32 XPValue( Player *pPlayer ) const;
 164
 165         bool HasFlag( uint32 flag ) const { return ( QuestFlags & flag ) != 0; }
 166         void SetFlag( uint32 flag ) { QuestFlags |= flag; }
 167
 168         // table data accessors:
 169         uint32 GetQuestId() const { return QuestId; }
 170         uint32 GetQuestMethod() const { return QuestMethod; }
 171         int32  GetZoneOrSort() const { return ZoneOrSort; }
 172         int32  GetSkillOrClass() const { return SkillOrClass; }
 173         uint32 GetMinLevel() const { return MinLevel; }
 174         uint32 GetQuestLevel() const { return QuestLevel; }
 175         uint32 GetType() const { return Type; }
 176         uint32 GetRequiredRaces() const { return RequiredRaces; }
 177         uint32 GetRequiredSkillValue() const { return RequiredSkillValue; }
 178         uint32 GetRepObjectiveFaction() const { return RepObjectiveFaction; }
 179         int32  GetRepObjectiveValue() const { return RepObjectiveValue; }
 180         uint32 GetRequiredMinRepFaction() const { return RequiredMinRepFaction; }
 181         int32  GetRequiredMinRepValue() const { return RequiredMinRepValue; }
 182         uint32 GetRequiredMaxRepFaction() const { return RequiredMaxRepFaction; }
 183         int32  GetRequiredMaxRepValue() const { return RequiredMaxRepValue; }
 184         uint32 GetSuggestedPlayers() const { return SuggestedPlayers; }
 185         uint32 GetLimitTime() const { return LimitTime; }
 186         int32  GetPrevQuestId() const { return PrevQuestId; }
 187         int32  GetNextQuestId() const { return NextQuestId; }
 188         int32  GetExclusiveGroup() const { return ExclusiveGroup; }
 189         uint32 GetNextQuestInChain() const { return NextQuestInChain; }
 190         uint32 GetCharTitleId() const { return CharTitleId; }
 191         uint32 GetSrcItemId() const { return SrcItemId; }
 192         uint32 GetSrcItemCount() const { return SrcItemCount; }
 193         uint32 GetSrcSpell() const { return SrcSpell; }
 194         std::string GetTitle() const { return Title; }
 195         std::string GetDetails() const { return Details; }
 196         std::string GetObjectives() const { return Objectives; }
 197         std::string GetOfferRewardText() const { return OfferRewardText; }
 198         std::string GetRequestItemsText() const { return RequestItemsText; }
 199         std::string GetEndText() const { return EndText; }
 200         int32  GetRewOrReqMoney() const;
 201         uint32 GetRewHonorableKills() const { return RewHonorableKills; }
 202         uint32 GetRewMoneyMaxLevel() const { return RewMoneyMaxLevel; }
 203                                                             // use in XP calculation at client
 204         uint32 GetRewSpell() const { return RewSpell; }
 205         uint32 GetRewSpellCast() const { return RewSpellCast; }
 206         uint32 GetRewMailTemplateId() const { return RewMailTemplateId; }
 207         uint32 GetRewMailDelaySecs() const { return RewMailDelaySecs; }
 208         uint32 GetPointMapId() const { return PointMapId; }
 209         float  GetPointX() const { return PointX; }
 210         float  GetPointY() const { return PointY; }
 211         uint32 GetPointOpt() const { return PointOpt; }
 212         uint32 GetIncompleteEmote() const { return IncompleteEmote; }
 213         uint32 GetCompleteEmote() const { return CompleteEmote; }
 214         uint32 GetQuestStartScript() const { return QuestStartScript; }
 215         uint32 GetQuestCompleteScript() const { return QuestCompleteScript; }
 216         bool   IsRepeatable() const { return QuestFlags & QUEST_MANGOS_FLAGS_REPEATABLE; }
 217         bool   IsAutoComplete() const { return QuestMethod ? false : true; }
 218         uint32 GetFlags() const { return QuestFlags; }
 219         bool   IsDaily() const { return QuestFlags & QUEST_FLAGS_DAILY; }
 220
 221         // multiple values
 222         std::string ObjectiveText[QUEST_OBJECTIVES_COUNT];
 223         uint32 ReqItemId[QUEST_OBJECTIVES_COUNT];
 224         uint32 ReqItemCount[QUEST_OBJECTIVES_COUNT];
 225         uint32 ReqSourceId[QUEST_SOURCE_ITEM_IDS_COUNT];
 226         uint32 ReqSourceCount[QUEST_SOURCE_ITEM_IDS_COUNT];
 227         uint32 ReqSourceRef[QUEST_SOURCE_ITEM_IDS_COUNT];
 228         int32  ReqCreatureOrGOId[QUEST_OBJECTIVES_COUNT];   // >0 Creature <0 Gameobject
 229         uint32 ReqCreatureOrGOCount[QUEST_OBJECTIVES_COUNT];
 230         uint32 ReqSpell[QUEST_OBJECTIVES_COUNT];
 231         uint32 RewChoiceItemId[QUEST_REWARD_CHOICES_COUNT];
 232         uint32 RewChoiceItemCount[QUEST_REWARD_CHOICES_COUNT];
 233         uint32 RewItemId[QUEST_REWARDS_COUNT];
 234         uint32 RewItemCount[QUEST_REWARDS_COUNT];
 235         uint32 RewRepFaction[QUEST_REPUTATIONS_COUNT];
 236         int32  RewRepValue[QUEST_REPUTATIONS_COUNT];
 237         uint32 DetailsEmote[QUEST_EMOTE_COUNT];
 238         uint32 OfferRewardEmote[QUEST_EMOTE_COUNT];
 239
 240         uint32 GetReqItemsCount() const { return m_reqitemscount; }
 241         uint32 GetReqCreatureOrGOcount() const { return m_reqCreatureOrGOcount; }
 242         uint32 GetRewChoiceItemsCount() const { return m_rewchoiceitemscount; }
 243         uint32 GetRewItemsCount() const { return m_rewitemscount; }
 244
 245         typedef std::vector<int32> PrevQuests;
 246         PrevQuests prevQuests;
 247         typedef std::vector<uint32> PrevChainQuests;
 248         PrevChainQuests prevChainQuests;
 249
 250         // cached data
 251     private:
 252         uint32 m_reqitemscount;
 253         uint32 m_reqCreatureOrGOcount;
 254         uint32 m_rewchoiceitemscount;
 255         uint32 m_rewitemscount;
 256
 257         // table data
 258     protected:
 259         uint32 QuestId;
 260         uint32 QuestMethod;
 261         int32  ZoneOrSort;
 262         int32  SkillOrClass;
 263         uint32 MinLevel;
 264         uint32 QuestLevel;
 265         uint32 Type;
 266         uint32 RequiredRaces;
 267         uint32 RequiredSkillValue;
 268         uint32 RepObjectiveFaction;
 269         int32  RepObjectiveValue;
 270         uint32 RequiredMinRepFaction;
 271         int32  RequiredMinRepValue;
 272         uint32 RequiredMaxRepFaction;
 273         int32  RequiredMaxRepValue;
 274         uint32 SuggestedPlayers;
 275         uint32 LimitTime;
 276         uint32 QuestFlags;
 277         uint32 CharTitleId;
 278         int32  PrevQuestId;
 279         int32  NextQuestId;
 280         int32  ExclusiveGroup;
 281         uint32 NextQuestInChain;
 282         uint32 SrcItemId;
 283         uint32 SrcItemCount;
 284         uint32 SrcSpell;
 285         std::string Title;
 286         std::string Details;
 287         std::string Objectives;
 288         std::string OfferRewardText;
 289         std::string RequestItemsText;
 290         std::string EndText;
 291         uint32 RewHonorableKills;
 292         int32  RewOrReqMoney;
 293         uint32 RewMoneyMaxLevel;
 294         uint32 RewSpell;
 295         uint32 RewSpellCast;
 296         uint32 RewMailTemplateId;
 297         uint32 RewMailDelaySecs;
 298         uint32 PointMapId;
 299         float  PointX;
 300         float  PointY;
 301         uint32 PointOpt;
 302         uint32 IncompleteEmote;
 303         uint32 CompleteEmote;
 304         uint32 QuestStartScript;
 305         uint32 QuestCompleteScript;
 306 };
 307
 308 enum QuestUpdateState
 309 {
 310     QUEST_UNCHANGED = 0,
 311     QUEST_CHANGED = 1,
 312     QUEST_NEW = 2
 313 };
 314
 315 struct QuestStatusData
 316 {
 317     QuestStatusData()
 318         : m_status(QUEST_STATUS_NONE),m_rewarded(false),
 319         m_explored(false), m_timer(0), uState(QUEST_NEW)
 320     {
 321         memset(m_itemcount,    0, QUEST_OBJECTIVES_COUNT * sizeof(uint32));
 322         memset(m_creatureOrGOcount, 0, QUEST_OBJECTIVES_COUNT * sizeof(uint32));
 323     }
 324
 325     QuestStatus m_status;
 326     bool m_rewarded;
 327     bool m_explored;
 328     uint32 m_timer;
 329     QuestUpdateState uState;
 330
 331     uint32 m_itemcount[ QUEST_OBJECTIVES_COUNT ];
 332     uint32 m_creatureOrGOcount[ QUEST_OBJECTIVES_COUNT ];
 333 };
 334 #endif