path: root/src/server/game/Quests/QuestDef.h

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef TRINITYCORE_QUEST_H
#define TRINITYCORE_QUEST_H

#include "Common.h"
#include "DBCEnums.h"
#include "DatabaseEnvFwd.h"
#include "Optional.h"
#include "RaceMask.h"
#include "SharedDefines.h"
#include "WorldPacket.h"
#include <vector>

class Player;
enum class LootItemType : uint8;

namespace WorldPackets
{
    namespace Quest
    {
        struct QuestRewards;
    }
}

#define MAX_QUEST_LOG_SIZE 25

#define QUEST_ITEM_DROP_COUNT 4
#define QUEST_REWARD_CHOICES_COUNT 6
#define QUEST_REWARD_ITEM_COUNT 4
#define QUEST_DEPLINK_COUNT 10
#define QUEST_REWARD_REPUTATIONS_COUNT 5
#define QUEST_EMOTE_COUNT 4
#define QUEST_REWARD_CURRENCY_COUNT 4
#define QUEST_REWARD_DISPLAY_SPELL_COUNT 3

enum QuestFailedReason
{
    QUEST_ERR_NONE                              = 0,
    QUEST_ERR_FAILED_LOW_LEVEL                  = 1,        // "You are not high enough level for that quest.""
    QUEST_ERR_FAILED_WRONG_RACE                 = 6,        // "That quest is not available to your race."
    QUEST_ERR_ALREADY_DONE                      = 7,        // "You have completed that daily quest today."
    QUEST_ERR_ONLY_ONE_TIMED                    = 12,       // "You can only be on one timed quest at a time"
    QUEST_ERR_ALREADY_ON1                       = 13,       // "You are already on that quest"
    QUEST_ERR_FAILED_EXPANSION                  = 16,       // "This quest requires an expansion enabled account."
    QUEST_ERR_ALREADY_ON2                       = 18,       // "You are already on that quest"
    QUEST_ERR_FAILED_MISSING_ITEMS              = 21,       // "You don't have the required items with you.  Check storage."
    QUEST_ERR_FAILED_NOT_ENOUGH_MONEY           = 23,       // "You don't have enough money for that quest"
    QUEST_ERR_FAILED_CAIS                       = 24,       // "You cannot complete quests once you have reached tired time"
    QUEST_ERR_ALREADY_DONE_DAILY                = 26,       // "You have completed that daily quest today."
    QUEST_ERR_FAILED_SPELL                      = 28,       // "You haven't learned the required spell."
    QUEST_ERR_HAS_IN_PROGRESS                   = 30        // "Progress Bar objective not completed"
};

enum QuestPushReason : uint8
{
    QUEST_PUSH_SUCCESS                  = 0,    // "Sharing quest with %s..."
    QUEST_PUSH_INVALID                  = 1,    // "%s is not eligible for that quest"
    QUEST_PUSH_ACCEPTED                 = 2,    // "%s has accepted your quest"
    QUEST_PUSH_DECLINED                 = 3,    // "%s has declined your quest"
    QUEST_PUSH_BUSY                     = 4,    // "%s is busy"
    QUEST_PUSH_DEAD                     = 5,    // "%s is dead."
    QUEST_PUSH_LOG_FULL                 = 6,    // "%s's quest log is full"
    QUEST_PUSH_ONQUEST                  = 7,    // "%s is already on that quest"
    QUEST_PUSH_ALREADY_DONE             = 8,    // "%s has completed that quest"
    QUEST_PUSH_NOT_DAILY                = 9,    // "That quest cannot be shared today"
    QUEST_PUSH_TIMER_EXPIRED            = 10,   // "Quest sharing timer has expired"
    QUEST_PUSH_NOT_IN_PARTY             = 11,   // "You are not in a party"
    QUEST_PUSH_DIFFERENT_SERVER_DAILY   = 12,   // "%s is not eligible for that quest today"
    QUEST_PUSH_NOT_ALLOWED              = 13    // "That quest cannot be shared"
};

enum QuestTradeSkill
{
    QUEST_TRSKILL_NONE           = 0,
    QUEST_TRSKILL_ALCHEMY        = 1,
    QUEST_TRSKILL_BLACKSMITHING  = 2,
    QUEST_TRSKILL_COOKING        = 3,
    QUEST_TRSKILL_ENCHANTING     = 4,
    QUEST_TRSKILL_ENGINEERING    = 5,
    QUEST_TRSKILL_FIRSTAID       = 6,
    QUEST_TRSKILL_HERBALISM      = 7,
    QUEST_TRSKILL_LEATHERWORKING = 8,
    QUEST_TRSKILL_POISONS        = 9,
    QUEST_TRSKILL_TAILORING      = 10,
    QUEST_TRSKILL_MINING         = 11,
    QUEST_TRSKILL_FISHING        = 12,
    QUEST_TRSKILL_SKINNING       = 13,
    QUEST_TRSKILL_JEWELCRAFTING  = 14
};

enum QuestStatus : uint8
{
    QUEST_STATUS_NONE           = 0,
    QUEST_STATUS_COMPLETE       = 1,
    //QUEST_STATUS_UNAVAILABLE    = 2,
    QUEST_STATUS_INCOMPLETE     = 3,
    //QUEST_STATUS_AVAILABLE      = 4,
    QUEST_STATUS_FAILED         = 5,
    QUEST_STATUS_REWARDED       = 6,        // Not used in DB
    MAX_QUEST_STATUS
};

enum class QuestGiverStatus : uint32
{
    None                                = 0x000000,
    Future                              = 0x000002,
    Trivial                             = 0x000004,
    TrivialRepeatableTurnin             = 0x000008,
    TrivialDailyQuest                   = 0x000010,
    Reward                              = 0x000020,
    JourneyReward                       = 0x000040,
    CovenantCallingReward               = 0x000080,
    RepeatableTurnin                    = 0x000100,
    DailyQuest                          = 0x000200,
    Quest                               = 0x000400,
    RewardCompleteNoPOI                 = 0x000800,
    RewardCompletePOI                   = 0x001000,
    LegendaryQuest                      = 0x002000,
    LegendaryRewardCompleteNoPOI        = 0x004000,
    LegendaryRewardCompletePOI          = 0x008000,
    JourneyQuest                        = 0x010000,
    JourneyRewardCompleteNoPOI          = 0x020000,
    JourneyRewardCompletePOI            = 0x040000,
    CovenantCallingQuest                = 0x080000,
    CovenantCallingRewardCompleteNoPOI  = 0x100000,
    CovenantCallingRewardCompletePOI    = 0x200000,

    ScriptedDefault                     = 0x80000000
};

DEFINE_ENUM_FLAG(QuestGiverStatus);

enum QuestFlags : uint32
{
    QUEST_FLAGS_NONE                        = 0x00000000,
    QUEST_FLAGS_STAY_ALIVE                  = 0x00000001,   // Not used currently
    QUEST_FLAGS_PARTY_ACCEPT                = 0x00000002,   // 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
    QUEST_FLAGS_EXPLORATION                 = 0x00000004,   // Not used currently
    QUEST_FLAGS_SHARABLE                    = 0x00000008,   // Can be shared: Player::CanShareQuest()
    QUEST_FLAGS_HAS_CONDITION               = 0x00000010,   // Not used currently
    QUEST_FLAGS_HIDE_REWARD_POI             = 0x00000020,   // Not used currently: Unsure of content
    QUEST_FLAGS_RAID                        = 0x00000040,   // Can be completed while in raid
    QUEST_FLAGS_WAR_MODE_REWARDS_OPT_IN     = 0x00000080,   // Not used currently
    QUEST_FLAGS_NO_MONEY_FROM_XP            = 0x00000100,   // Not used currently: Experience is not converted to gold at max level
    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))
    QUEST_FLAGS_TRACKING                    = 0x00000400,   // These quests are automatically rewarded on quest complete and they will never appear in quest log client side.
    QUEST_FLAGS_DEPRECATE_REPUTATION        = 0x00000800,   // Not used currently
    QUEST_FLAGS_DAILY                       = 0x00001000,   // Used to know quest is Daily one
    QUEST_FLAGS_FLAGS_PVP                   = 0x00002000,   // Having this quest in log forces PvP flag
    QUEST_FLAGS_UNAVAILABLE                 = 0x00004000,   // Used on quests that are not generically available
    QUEST_FLAGS_WEEKLY                      = 0x00008000,
    QUEST_FLAGS_AUTOCOMPLETE                = 0x00010000,   // Quests with this flag player submit automatically by special button in player gui
    QUEST_FLAGS_DISPLAY_ITEM_IN_TRACKER     = 0x00020000,   // Displays usable item in quest tracker
    QUEST_FLAGS_OBJ_TEXT                    = 0x00040000,   // use Objective text as Complete text
    QUEST_FLAGS_AUTO_ACCEPT                 = 0x00080000,   // The client recognizes this flag as auto-accept.
    QUEST_FLAGS_PLAYER_CAST_ON_ACCEPT       = 0x00100000,
    QUEST_FLAGS_PLAYER_CAST_ON_COMPLETE     = 0x00200000,
    QUEST_FLAGS_UPDATE_PHASE_SHIFT          = 0x00400000,
    QUEST_FLAGS_SOR_WHITELIST               = 0x00800000,
    QUEST_FLAGS_LAUNCH_GOSSIP_COMPLETE      = 0x01000000,
    QUEST_FLAGS_REMOVE_EXTRA_GET_ITEMS      = 0x02000000,
    QUEST_FLAGS_HIDE_UNTIL_DISCOVERED       = 0x04000000,
    QUEST_FLAGS_PORTRAIT_IN_QUEST_LOG       = 0x08000000,
    QUEST_FLAGS_SHOW_ITEM_WHEN_COMPLETED    = 0x10000000,
    QUEST_FLAGS_LAUNCH_GOSSIP_ACCEPT        = 0x20000000,
    QUEST_FLAGS_ITEMS_GLOW_WHEN_DONE        = 0x40000000,
    QUEST_FLAGS_FAIL_ON_LOGOUT              = 0x80000000
};

// last checked in 19802
enum QuestFlagsEx : uint32
{
    QUEST_FLAGS_EX_NONE                                                 = 0x00000000,
    QUEST_FLAGS_EX_KEEP_ADDITIONAL_ITEMS                                = 0x00000001,
    QUEST_FLAGS_EX_SUPPRESS_GOSSIP_COMPLETE                             = 0x00000002,
    QUEST_FLAGS_EX_SUPPRESS_GOSSIP_ACCEPT                               = 0x00000004,
    QUEST_FLAGS_EX_DISALLOW_PLAYER_AS_QUESTGIVER                        = 0x00000008,
    QUEST_FLAGS_EX_DISPLAY_CLASS_CHOICE_REWARDS                         = 0x00000010,
    QUEST_FLAGS_EX_DISPLAY_SPEC_CHOICE_REWARDS                          = 0x00000020,
    QUEST_FLAGS_EX_REMOVE_FROM_LOG_ON_PERIDOIC_RESET                    = 0x00000040,
    QUEST_FLAGS_EX_ACCOUNT_LEVEL_QUEST                                  = 0x00000080,
    QUEST_FLAGS_EX_LEGENDARY_QUEST                                      = 0x00000100,
    QUEST_FLAGS_EX_NO_GUILD_XP                                          = 0x00000200,
    QUEST_FLAGS_EX_RESET_CACHE_ON_ACCEPT                                = 0x00000400,
    QUEST_FLAGS_EX_NO_ABANDON_ONCE_ANY_OBJECTIVE_COMPLETE               = 0x00000800,
    QUEST_FLAGS_EX_RECAST_ACCEPT_SPELL_ON_LOGIN                         = 0x00001000,
    QUEST_FLAGS_EX_UPDATE_ZONE_AURAS                                    = 0x00002000,
    QUEST_FLAGS_EX_NO_CREDIT_FOR_PROXY                                  = 0x00004000,
    QUEST_FLAGS_EX_DISPLAY_AS_DAILY_QUEST                               = 0x00008000,
    QUEST_FLAGS_EX_PART_OF_QUEST_LINE                                   = 0x00010000,
    QUEST_FLAGS_EX_QUEST_FOR_INTERNAL_BUILDS_ONLY                       = 0x00020000,
    QUEST_FLAGS_EX_SUPPRESS_SPELL_LEARN_TEXT_LINE                       = 0x00040000,
    QUEST_FLAGS_EX_DISPLAY_HEADER_AS_OBJECTIVE_FOR_TASKS                = 0x00080000,
    QUEST_FLAGS_EX_GARRISON_NON_OWNERS_ALLOWED                          = 0x00100000,
    QUEST_FLAGS_EX_REMOVE_QUEST_ON_WEEKLY_RESET                         = 0x00200000,
    QUEST_FLAGS_EX_SUPPRESS_FAREWELL_AUDIO_AFTER_QUEST_ACCEPT           = 0x00400000,
    QUEST_FLAGS_EX_REWARDS_BYPASS_WEEKLY_CAPS_AND_SEASON_TOTAL          = 0x00800000,
    QUEST_FLAGS_EX_IS_WORLD_QUEST                                       = 0x01000000,
    QUEST_FLAGS_EX_NOT_IGNORABLE                                        = 0x02000000,
    QUEST_FLAGS_EX_AUTO_PUSH                                            = 0x04000000,
    QUEST_FLAGS_EX_NO_SPELL_COMPLETE_EFFECTS                            = 0x08000000,
    QUEST_FLAGS_EX_DO_NOT_TOAST_HONOR_REWARD                            = 0x10000000,
    QUEST_FLAGS_EX_KEEP_REPEATABLE_QUEST_ON_FACTION_CHANGE              = 0x20000000,
    QUEST_FLAGS_EX_KEEP_PROGRESS_ON_FACTION_CHANGE                      = 0x40000000,
    QUEST_FLAGS_EX_PUSH_TEAM_QUEST_USING_MAP_CONTROLLER                 = 0x80000000
};

enum QuestFlagsEx2 : uint32
{
    QUEST_FLAGS_EX2_RESET_ON_GAME_MILESTONE         = 0x00000001,
    QUEST_FLAGS_EX2_NO_WAR_MODE_BONUS               = 0x00000002,
    QUEST_FLAGS_EX2_AWARD_HIGHEST_PROFESSION        = 0x00000004,
    QUEST_FLAGS_EX2_NOT_REPLAYABLE                  = 0x00000008,
    QUEST_FLAGS_EX2_NO_REPLAY_REWARDS               = 0x00000010,
    QUEST_FLAGS_EX2_DISABLE_WAYPOINT_PATHING        = 0x00000020,
    QUEST_FLAGS_EX2_RESET_ON_MYTHIC_PLUS_SEASON     = 0x00000040,
    QUEST_FLAGS_EX2_RESET_ON_PVP_SEASON             = 0x00000080,
    QUEST_FLAGS_EX2_ENABLE_OVERRIDE_SORT_ORDER      = 0x00000100,
    QUEST_FLAGS_EX2_FORCE_STARTING_LOC_ON_ZONE_MAP  = 0x00000200,
    QUEST_FLAGS_EX2_BONUS_LOOT_NEVER                = 0x00000400,
    QUEST_FLAGS_EX2_BONUS_LOOT_ALWAYS               = 0x00000800,
    QUEST_FLAGS_EX2_HIDE_TASK_ON_MAIN_MAP           = 0x00001000,
    QUEST_FLAGS_EX2_HIDE_TASK_IN_TRACKER            = 0x00002000,
    QUEST_FLAGS_EX2_SKIP_DISABLED_CHECK             = 0x00004000,
    QUEST_FLAGS_EX2_ENFORCE_MAXIMUM_QUEST_LEVEL     = 0x00008000
};

enum QuestSpecialFlags
{
    QUEST_SPECIAL_FLAGS_NONE                 = 0x000,
    // Trinity flags for set SpecialFlags in DB if required but used only at server
    QUEST_SPECIAL_FLAGS_REPEATABLE           = 0x001,   // Set by 1 in SpecialFlags from DB
    QUEST_SPECIAL_FLAGS_EXPLORATION_OR_EVENT = 0x002,   // Set by 2 in SpecialFlags from DB (if required area explore, spell SPELL_EFFECT_QUEST_COMPLETE casting, table `FECT_QUEST_COMPLETE casting, table `*_script` command SCRIPT_COMMAND_QUEST_EXPLORED use, set from script)
    QUEST_SPECIAL_FLAGS_AUTO_ACCEPT          = 0x004,   // Set by 4 in SpecialFlags in DB if the quest is to be auto-accepted.
    QUEST_SPECIAL_FLAGS_DF_QUEST             = 0x008,   // Set by 8 in SpecialFlags in DB if the quest is used by Dungeon Finder.
    QUEST_SPECIAL_FLAGS_MONTHLY              = 0x010,   // Set by 16 in SpecialFlags in DB if the quest is reset at the begining of the month
    QUEST_SPECIAL_FLAGS_CAST                 = 0x020,   // Set by 32 in SpecialFlags in DB if the quest requires RequiredOrNpcGo killcredit but NOT kill (a spell cast)
    // room for more custom flags

    QUEST_SPECIAL_FLAGS_DB_ALLOWED = QUEST_SPECIAL_FLAGS_REPEATABLE | QUEST_SPECIAL_FLAGS_EXPLORATION_OR_EVENT | QUEST_SPECIAL_FLAGS_AUTO_ACCEPT | QUEST_SPECIAL_FLAGS_DF_QUEST | QUEST_SPECIAL_FLAGS_MONTHLY | QUEST_SPECIAL_FLAGS_CAST,

    QUEST_SPECIAL_FLAGS_DELIVER              = 0x080,   // Internal flag computed only
    QUEST_SPECIAL_FLAGS_SPEAKTO              = 0x100,   // Internal flag computed only
    QUEST_SPECIAL_FLAGS_KILL                 = 0x200,   // Internal flag computed only
    QUEST_SPECIAL_FLAGS_TIMED                = 0x400,   // Internal flag computed only
    QUEST_SPECIAL_FLAGS_PLAYER_KILL          = 0x800,   // Internal flag computed only
    QUEST_SPECIAL_FLAGS_COMPLETED_AT_START   = 0x1000   // Internal flag computed only
};

enum class QuestTagType
{
    Tag,
    Profession,
    Normal,
    Pvp,
    PetBattle,
    Bounty,
    Dungeon,
    Invasion,
    Raid,
    Contribution,
    RatedRreward,
    InvasionWrapper,
    FactionAssault,
    Islands,
    Threat,
    CovenantCalling
};

enum QuestObjectiveType
{
    QUEST_OBJECTIVE_MONSTER                 = 0,
    QUEST_OBJECTIVE_ITEM                    = 1,
    QUEST_OBJECTIVE_GAMEOBJECT              = 2,
    QUEST_OBJECTIVE_TALKTO                  = 3,
    QUEST_OBJECTIVE_CURRENCY                = 4,
    QUEST_OBJECTIVE_LEARNSPELL              = 5,
    QUEST_OBJECTIVE_MIN_REPUTATION          = 6,
    QUEST_OBJECTIVE_MAX_REPUTATION          = 7,
    QUEST_OBJECTIVE_MONEY                   = 8,
    QUEST_OBJECTIVE_PLAYERKILLS             = 9,
    QUEST_OBJECTIVE_AREATRIGGER             = 10,
    QUEST_OBJECTIVE_WINPETBATTLEAGAINSTNPC  = 11,
    QUEST_OBJECTIVE_DEFEATBATTLEPET         = 12,
    QUEST_OBJECTIVE_WINPVPPETBATTLES        = 13,
    QUEST_OBJECTIVE_CRITERIA_TREE           = 14,
    QUEST_OBJECTIVE_PROGRESS_BAR            = 15,
    QUEST_OBJECTIVE_HAVE_CURRENCY           = 16,   // requires the player to have X currency when turning in but does not consume it
    QUEST_OBJECTIVE_OBTAIN_CURRENCY         = 17,   // requires the player to gain X currency after starting the quest but not required to keep it until the end (does not consume)
    QUEST_OBJECTIVE_INCREASE_REPUTATION     = 18,   // requires the player to gain X reputation with a faction
    QUEST_OBJECTIVE_AREA_TRIGGER_ENTER      = 19,
    QUEST_OBJECTIVE_AREA_TRIGGER_EXIT       = 20
};

enum QuestObjectiveFlags
{
    QUEST_OBJECTIVE_FLAG_TRACKED_ON_MINIMAP                 = 0x01, // client displays large yellow blob on minimap for creature/gameobject
    QUEST_OBJECTIVE_FLAG_SEQUENCED                          = 0x02, // client will not see the objective displayed until all previous objectives are completed
    QUEST_OBJECTIVE_FLAG_OPTIONAL                           = 0x04, // not required to complete the quest
    QUEST_OBJECTIVE_FLAG_HIDDEN                             = 0x08, // never displayed in quest log
    QUEST_OBJECTIVE_FLAG_HIDE_CREDIT_MSG                    = 0x10, // skip showing item objective progress
    QUEST_OBJECTIVE_FLAG_PRESERVE_QUEST_ITEMS               = 0x20,
    QUEST_OBJECTIVE_FLAG_PART_OF_PROGRESS_BAR               = 0x40, // hidden objective used to calculate progress bar percent (quests are limited to a single progress bar objective)
    QUEST_OBJECTIVE_FLAG_KILL_PLAYERS_SAME_FACTION          = 0x80
};

struct QuestGreeting
{
    uint16 EmoteType;
    uint32 EmoteDelay;
    std::string Text;

    QuestGreeting() : EmoteType(0), EmoteDelay(0) { }
    QuestGreeting(uint16 emoteType, uint32 emoteDelay, std::string text)
        : EmoteType(emoteType), EmoteDelay(emoteDelay), Text(std::move(text)) { }
};

struct QuestGreetingLocale
{
    std::vector<std::string> Greeting;
};

struct QuestTemplateLocale
{
    std::vector<std::string> LogTitle;
    std::vector<std::string> LogDescription;
    std::vector<std::string> QuestDescription;
    std::vector<std::string> AreaDescription;
    std::vector<std::string> PortraitGiverText;
    std::vector<std::string> PortraitGiverName;
    std::vector<std::string> PortraitTurnInText;
    std::vector<std::string> PortraitTurnInName;
    std::vector<std::string> QuestCompletionLog;
};

struct QuestRequestItemsLocale
{
    std::vector<std::string> CompletionText;
};

struct QuestObjectivesLocale
{
    std::vector<std::string> Description;
};

struct QuestOfferRewardLocale
{
    std::vector<std::string> RewardText;
};

struct QuestObjective
{
    uint32 ID           = 0;
    uint32 QuestID      = 0;
    uint8  Type         = 0;
    int8   StorageIndex = 0;
    int32  ObjectID     = 0;
    int32  Amount       = 0;
    uint32 Flags        = 0;
    uint32 Flags2       = 0;
    float  ProgressBarWeight = 0.0f;
    std::string Description;
    std::vector<int32> VisualEffects;

    bool IsStoringFlag() const
    {
        switch (Type)
        {
            case QUEST_OBJECTIVE_AREATRIGGER:
            case QUEST_OBJECTIVE_WINPETBATTLEAGAINSTNPC:
            case QUEST_OBJECTIVE_DEFEATBATTLEPET:
            case QUEST_OBJECTIVE_CRITERIA_TREE:
                return true;
            default:
                break;
        }
        return false;
    }
};

using QuestObjectives = std::vector<QuestObjective>;

struct QuestRewardDisplaySpell
{
    QuestRewardDisplaySpell() : SpellId(0), PlayerConditionId(0) { }
    QuestRewardDisplaySpell(uint32 spellId, uint32 playerConditionId) : SpellId(spellId), PlayerConditionId(playerConditionId) { }

    uint32 SpellId;
    uint32 PlayerConditionId;
};

// This Quest class provides a convenient way to access a few pretotaled (cached) quest details,
// all base quest information, and any utility functions such as generating the amount of
// xp to give
class TC_GAME_API Quest
{
    friend class ObjectMgr;
    friend class Player;
    friend class PlayerMenu;
    public:
        // Loading data. All queries are in ObjectMgr::LoadQuests()
        explicit Quest(Field* questRecord);
        void LoadRewardDisplaySpell(Field* fields);
        void LoadRewardChoiceItems(Field* fields);
        void LoadQuestDetails(Field* fields);
        void LoadQuestRequestItems(Field* fields);
        void LoadQuestOfferReward(Field* fields);
        void LoadQuestTemplateAddon(Field* fields);
        void LoadQuestMailSender(Field* fields);
        void LoadQuestObjective(Field* fields);
        void LoadQuestObjectiveVisualEffect(Field* fields);

        uint32 XPValue(Player const* player) const;
        uint32 MoneyValue(Player const* player) const;
        Optional<QuestTagType> GetQuestTag() const;

        bool HasFlag(QuestFlags flag) const { return (_flags & uint32(flag)) != 0; }
        bool HasFlagEx(QuestFlagsEx flag) const { return (_flagsEx & uint32(flag)) != 0; }
        bool HasFlagEx2(QuestFlagsEx2 flag) const { return (_flagsEx2 & uint32(flag)) != 0; }

        bool HasSpecialFlag(uint32 flag) const { return (_specialFlags & flag) != 0; }
        void SetSpecialFlag(uint32 flag) { _specialFlags |= flag; }

        bool IsAutoPush() const { return HasFlagEx(QUEST_FLAGS_EX_AUTO_PUSH); }
        bool IsWorldQuest() const { return HasFlagEx(QUEST_FLAGS_EX_IS_WORLD_QUEST); }

        // Possibly deprecated flag
        bool IsUnavailable() const { return HasFlag(QUEST_FLAGS_UNAVAILABLE); }

        // table data accessors:
        uint32 GetQuestId() const { return _id; }
        uint32 GetQuestType() const { return _type; }
        uint32 GetQuestPackageID() const { return _packageID; }
        uint32 GetContentTuningId() const { return _contentTuningID; }
        int32  GetZoneOrSort() const { return _questSortID; }
        uint32 GetMaxLevel() const { return _maxLevel; }
        uint32 GetQuestInfoID() const { return _questInfoID; }
        uint32 GetAllowableClasses() const { return _allowableClasses; }
        Trinity::RaceMask<uint64> GetAllowableRaces() const { return _allowableRaces; }
        uint32 GetRequiredSkill() const { return _requiredSkillId; }
        uint32 GetRequiredSkillValue() const { return _requiredSkillPoints; }
        uint32 GetRequiredMinRepFaction() const { return _requiredMinRepFaction; }
        int32  GetRequiredMinRepValue() const { return _requiredMinRepValue; }
        uint32 GetRequiredMaxRepFaction() const { return _requiredMaxRepFaction; }
        int32  GetRequiredMaxRepValue() const { return _requiredMaxRepValue; }
        uint32 GetSuggestedPlayers() const { return _suggestedPlayers; }
        uint32 GetLimitTime() const { return _limitTime; }
        int32  GetPrevQuestId() const { return _prevQuestID; }
        uint32  GetNextQuestId() const { return _nextQuestID; }
        int32  GetExclusiveGroup() const { return _exclusiveGroup; }
        uint32 GetNextQuestInChain() const { return _nextQuestInChain; }
        int32  GetRewArenaPoints() const {return _rewardArenaPoints; }
        uint32 GetXPDifficulty() const { return _rewardXPDifficulty; }
        float  GetXPMultiplier() const { return _rewardXPMultiplier; }
        float  GetMoneyMultiplier() const { return _rewardMoneyMultiplier; }
        uint32 GetSrcItemId() const { return _sourceItemId; }
        uint32 GetSrcItemCount() const { return _sourceItemIdCount; }
        uint32 GetSrcSpell() const { return _sourceSpellID; }
        std::string const& GetLogTitle() const { return _logTitle; }
        std::string const& GetLogDescription() const { return _logDescription; }
        std::string const& GetQuestDescription() const { return _questDescription; }
        std::string const& GetAreaDescription() const { return _areaDescription; }
        std::string const& GetOfferRewardText() const { return _offerRewardText; }
        std::string const& GetRequestItemsText() const { return _requestItemsText; }
        std::string const& GetQuestCompletionLog() const { return _questCompletionLog; }
        std::string const& GetPortraitGiverText() const { return _portraitGiverText; }
        std::string const& GetPortraitGiverName() const { return _portraitGiverName; }
        std::string const& GetPortraitTurnInText() const { return _portraitTurnInText; }
        std::string const& GetPortraitTurnInName() const { return _portraitTurnInName; }
        QuestObjectives const& GetObjectives() const { return Objectives; }
        uint32 GetRewMoney() const { return _rewardMoney; }
        uint32 GetRewMoneyDifficulty() const { return _rewardMoneyDifficulty; }
        uint32 GetRewHonor() const { return _rewardHonor; }
        uint32 GetRewKillHonor() const { return _rewardKillHonor; }
        uint32 GetArtifactXPDifficulty() const { return _rewardArtifactXPDifficulty; }
        float  GetArtifactXPMultiplier() const { return _rewardArtifactXPMultiplier; }
        uint32 GetArtifactCategoryId() const { return _rewardArtifactCategoryID; }
        uint32 GetRewMoneyMaxLevel() const; // use in XP calculation at client
        uint32 GetRewSpell() const { return _rewardSpell; }
        uint32 GetRewMailTemplateId() const { return _rewardMailTemplateId; }
        uint32 GetRewMailDelaySecs() const { return _rewardMailDelay; }
        uint32 GetRewMailSenderEntry() const { return _rewardMailSenderEntry; }
        uint32 GetRewTitle() const { return _rewardTitleId; }
        uint32 GetPOIContinent() const { return _poiContinent; }
        float  GetPOIx() const { return _poix; }
        float  GetPOIy() const { return _poiy; }
        uint32 GetPOIPriority() const { return _poiPriority; }
        uint32 GetSoundAccept() const { return _soundAccept; }
        uint32 GetSoundTurnIn() const { return _soundTurnIn; }
        uint32 GetIncompleteEmote() const { return _emoteOnIncomplete; }
        uint32 GetCompleteEmote() const { return _emoteOnComplete; }
        uint32 GetIncompleteEmoteDelay() const { return _emoteOnIncompleteDelay; }
        uint32 GetCompleteEmoteDelay() const { return _emoteOnCompleteDelay; }
        bool   IsRepeatable() const { return _specialFlags & QUEST_SPECIAL_FLAGS_REPEATABLE; }
        bool   IsAutoAccept() const;
        bool   IsAutoComplete() const;
        uint32 GetFlags() const { return _flags; }
        uint32 GetFlagsEx() const { return _flagsEx; }
        uint32 GetFlagsEx2() const { return _flagsEx2; }
        uint32 GetSpecialFlags() const { return _specialFlags; }
        uint32 GetScriptId() const { return _scriptId; }
        uint32 GetAreaGroupID() const { return _areaGroupID; }
        uint32 GetRewardSkillId() const { return _rewardSkillId; }
        uint32 GetRewardSkillPoints() const { return _rewardSkillPoints; }
        uint32 GetRewardReputationMask() const { return _rewardReputationMask; }
        int32 GetTreasurePickerId() const { return _treasurePickerID; }
        int32 GetExpansion() const { return _expansion; }
        int32 GetManagedWorldStateId() const { return _managedWorldStateID; }
        int32 GetQuestSessionBonus() const { return _questSessionBonus; }
        uint32 GetQuestGiverPortrait() const { return _questGiverPortrait; }
        int32 GetQuestGiverPortraitMount() const { return _questGiverPortraitMount; }
        uint32 GetQuestTurnInPortrait() const { return _questTurnInPortrait; }
        bool   IsDaily() const { return (_flags & QUEST_FLAGS_DAILY) != 0; }
        bool   IsWeekly() const { return (_flags & QUEST_FLAGS_WEEKLY) != 0; }
        bool   IsMonthly() const { return (_specialFlags & QUEST_SPECIAL_FLAGS_MONTHLY) != 0; }
        bool   IsSeasonal() const { return (_questSortID == -QUEST_SORT_SEASONAL || _questSortID == -QUEST_SORT_SPECIAL || _questSortID == -QUEST_SORT_LUNAR_FESTIVAL || _questSortID == -QUEST_SORT_MIDSUMMER || _questSortID == -QUEST_SORT_BREWFEST || _questSortID == -QUEST_SORT_LOVE_IS_IN_THE_AIR || _questSortID == -QUEST_SORT_NOBLEGARDEN) && !IsRepeatable(); }
        bool   IsDailyOrWeekly() const { return (_flags & (QUEST_FLAGS_DAILY | QUEST_FLAGS_WEEKLY)) != 0; }
        bool   IsRaidQuest(Difficulty difficulty) const;
        bool   IsAllowedInRaid(Difficulty difficulty) const;
        bool   IsDFQuest() const { return (_specialFlags & QUEST_SPECIAL_FLAGS_DF_QUEST) != 0; }
        uint32 CalculateHonorGain(uint8 level) const;
        bool   CanIncreaseRewardedQuestCounters() const;

        // multiple values
        std::vector<QuestRewardDisplaySpell> RewardDisplaySpell;
        std::array<uint32, QUEST_REWARD_ITEM_COUNT> RewardItemId = { };
        std::array<uint32, QUEST_REWARD_ITEM_COUNT> RewardItemCount = { };
        std::array<uint32, QUEST_ITEM_DROP_COUNT> ItemDrop = { };
        std::array<uint32, QUEST_ITEM_DROP_COUNT> ItemDropQuantity = { };
        std::array<LootItemType, QUEST_REWARD_CHOICES_COUNT> RewardChoiceItemType = { };
        std::array<uint32, QUEST_REWARD_CHOICES_COUNT> RewardChoiceItemId = { };
        std::array<uint32, QUEST_REWARD_CHOICES_COUNT> RewardChoiceItemCount = { };
        std::array<uint32, QUEST_REWARD_CHOICES_COUNT> RewardChoiceItemDisplayId = { };
        std::array<uint32, QUEST_REWARD_REPUTATIONS_COUNT> RewardFactionId = { };
        std::array<int32, QUEST_REWARD_REPUTATIONS_COUNT>  RewardFactionValue = { };
        std::array<int32, QUEST_REWARD_REPUTATIONS_COUNT>  RewardFactionOverride = { };
        std::array<int32, QUEST_REWARD_REPUTATIONS_COUNT> RewardFactionCapIn = { };
        std::array<uint32, QUEST_REWARD_CURRENCY_COUNT> RewardCurrencyId = { };
        std::array<uint32, QUEST_REWARD_CURRENCY_COUNT> RewardCurrencyCount = { };
        QuestObjectives Objectives;
        std::array<uint32, QUEST_EMOTE_COUNT> DetailsEmote = { };
        std::array<uint32, QUEST_EMOTE_COUNT> DetailsEmoteDelay = { };
        std::array<uint32, QUEST_EMOTE_COUNT> OfferRewardEmote = { };
        std::array<uint32, QUEST_EMOTE_COUNT> OfferRewardEmoteDelay = { };

        uint32 GetRewChoiceItemsCount() const { return _rewChoiceItemsCount; }
        uint32 GetRewItemsCount() const { return _rewItemsCount; }
        uint32 GetRewCurrencyCount() const { return _rewCurrencyCount; }

        void SetEventIdForQuest(uint16 eventId) { _eventIdForQuest = eventId; }
        uint16 GetEventIdForQuest() const { return _eventIdForQuest; }

        void InitializeQueryData();
        WorldPacket BuildQueryData(LocaleConstant loc) const;

        void BuildQuestRewards(WorldPackets::Quest::QuestRewards& rewards, Player* player) const;

        std::vector<uint32> DependentPreviousQuests;
        std::array<WorldPacket, TOTAL_LOCALES> QueryData;

    private:
        uint32 _rewChoiceItemsCount = 0;
        uint32 _rewItemsCount = 0;
        uint16 _eventIdForQuest = 0;
        uint32 _rewCurrencyCount = 0;

        // wdb data (quest query response)
        uint32 _id = 0;
        uint32 _type = 0;
        uint32 _packageID = 0;
        uint32 _contentTuningID = 0;
        int32  _questSortID = 0;
        uint32 _questInfoID = 0;
        uint32 _suggestedPlayers = 0;
        uint32 _nextQuestInChain = 0;
        uint32 _rewardXPDifficulty = 0;
        float  _rewardXPMultiplier = 0.f;
        int32  _rewardMoney = 0;
        uint32 _rewardMoneyDifficulty = 0;
        float  _rewardMoneyMultiplier = 0.f;
        uint32 _rewardBonusMoney = 0;
        uint32 _rewardSpell = 0;
        uint32 _rewardHonor = 0;
        uint32 _rewardKillHonor = 0;
        uint32 _rewardArtifactXPDifficulty = 0;
        float  _rewardArtifactXPMultiplier = 0.f;
        uint32 _rewardArtifactCategoryID = 0;
        uint32 _sourceItemId = 0;
        uint32 _flags = 0;
        uint32 _flagsEx = 0;
        uint32 _flagsEx2 = 0;
        uint32 _poiContinent = 0;
        float  _poix = 0.f;
        float  _poiy = 0.f;
        uint32 _poiPriority = 0;
        uint32 _rewardTitleId = 0;
        int32  _rewardArenaPoints = 0;
        uint32 _rewardSkillId = 0;
        uint32 _rewardSkillPoints = 0;
        uint32 _questGiverPortrait = 0;
        int32 _questGiverPortraitMount = 0;
        uint32 _questTurnInPortrait = 0;
        uint32 _rewardReputationMask;
        uint32 _soundAccept = 0;
        uint32 _soundTurnIn = 0;
        uint32 _areaGroupID = 0;
        uint32 _limitTime = 0;
        Trinity::RaceMask<uint64> _allowableRaces;
        int32 _treasurePickerID = 0;
        int32 _expansion = 0;
        int32 _managedWorldStateID = 0;
        int32 _questSessionBonus = 0;
        std::string _logTitle;
        std::string _logDescription;
        std::string _questDescription;
        std::string _areaDescription;
        std::string _portraitGiverText;
        std::string _portraitGiverName;
        std::string _portraitTurnInText;
        std::string _portraitTurnInName;
        std::string _questCompletionLog;

        // quest_request_items table
        uint32 _emoteOnComplete          = 0;
        uint32 _emoteOnIncomplete        = 0;
        uint32 _emoteOnCompleteDelay     = 0;
        uint32 _emoteOnIncompleteDelay   = 0;
        std::string _requestItemsText;

        // quest_offer_reward table
        std::string _offerRewardText;

        // quest_template_addon table (custom data)
        uint32 _maxLevel             = 0;
        uint32 _allowableClasses     = 0;
        uint32 _sourceSpellID        = 0;
        int32  _prevQuestID          = 0;
        uint32  _nextQuestID         = 0;
        int32  _exclusiveGroup       = 0;
        uint32 _rewardMailTemplateId = 0;
        uint32 _rewardMailDelay      = 0;
        uint32 _requiredSkillId      = 0;
        uint32 _requiredSkillPoints  = 0;
        uint32 _requiredMinRepFaction = 0;
        int32  _requiredMinRepValue  = 0;
        uint32 _requiredMaxRepFaction = 0;
        int32  _requiredMaxRepValue  = 0;
        uint32 _sourceItemIdCount    = 0;
        uint32 _rewardMailSenderEntry = 0;
        uint32 _specialFlags         = 0; // custom flags, not sniffed/WDB
        uint32 _scriptId             = 0;

        // Helpers
        static uint32 RoundXPValue(uint32 xp);
};

struct QuestStatusData
{
    QuestStatus Status = QUEST_STATUS_NONE;
    uint32 Timer = 0;
    std::vector<int32> ObjectiveData;
};

#endif