src/game/GossipDef.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_GOSSIP_H
  20 #define MANGOSSERVER_GOSSIP_H
  21
  22 #include "Common.h"
  23 #include "QuestDef.h"
  24 #include "NPCHandler.h"
  25
  26 class WorldSession;
  27
  28 #define GOSSIP_MAX_MENU_ITEMS 64                            // client supported items unknown, but provided number must be enough
  29 #define DEFAULT_GOSSIP_MESSAGE              0xffffff
  30
  31 enum Gossip_Option
  32 {
  33     GOSSIP_OPTION_NONE              = 0,                    //UNIT_NPC_FLAG_NONE                (0)
  34     GOSSIP_OPTION_GOSSIP            = 1,                    //UNIT_NPC_FLAG_GOSSIP              (1)
  35     GOSSIP_OPTION_QUESTGIVER        = 2,                    //UNIT_NPC_FLAG_QUESTGIVER          (2)
  36     GOSSIP_OPTION_VENDOR            = 3,                    //UNIT_NPC_FLAG_VENDOR              (128)
  37     GOSSIP_OPTION_TAXIVENDOR        = 4,                    //UNIT_NPC_FLAG_TAXIVENDOR          (8192)
  38     GOSSIP_OPTION_TRAINER           = 5,                    //UNIT_NPC_FLAG_TRAINER             (16)
  39     GOSSIP_OPTION_SPIRITHEALER      = 6,                    //UNIT_NPC_FLAG_SPIRITHEALER        (16384)
  40     GOSSIP_OPTION_SPIRITGUIDE       = 7,                    //UNIT_NPC_FLAG_SPIRITGUIDE         (32768)
  41     GOSSIP_OPTION_INNKEEPER         = 8,                    //UNIT_NPC_FLAG_INNKEEPER           (65536)
  42     GOSSIP_OPTION_BANKER            = 9,                    //UNIT_NPC_FLAG_BANKER              (131072)
  43     GOSSIP_OPTION_PETITIONER        = 10,                   //UNIT_NPC_FLAG_PETITIONER          (262144)
  44     GOSSIP_OPTION_TABARDDESIGNER    = 11,                   //UNIT_NPC_FLAG_TABARDDESIGNER      (524288)
  45     GOSSIP_OPTION_BATTLEFIELD       = 12,                   //UNIT_NPC_FLAG_BATTLEFIELDPERSON   (1048576)
  46     GOSSIP_OPTION_AUCTIONEER        = 13,                   //UNIT_NPC_FLAG_AUCTIONEER          (2097152)
  47     GOSSIP_OPTION_STABLEPET         = 14,                   //UNIT_NPC_FLAG_STABLE              (4194304)
  48     GOSSIP_OPTION_ARMORER           = 15,                   //UNIT_NPC_FLAG_ARMORER             (4096)
  49     GOSSIP_OPTION_UNLEARNTALENTS    = 16,                   //UNIT_NPC_FLAG_TRAINER             (16) (bonus option for GOSSIP_OPTION_TRAINER)
  50     GOSSIP_OPTION_UNLEARNPETSKILLS  = 17,                   //UNIT_NPC_FLAG_TRAINER             (16) (bonus option for GOSSIP_OPTION_TRAINER)
  51     GOSSIP_OPTION_MAX
  52 };
  53
  54 enum GossipOptionIcon
  55 {
  56     GOSSIP_ICON_CHAT                = 0,                    //white chat bubble
  57     GOSSIP_ICON_VENDOR              = 1,                    //brown bag
  58     GOSSIP_ICON_TAXI                = 2,                    //flight
  59     GOSSIP_ICON_TRAINER             = 3,                    //book
  60     GOSSIP_ICON_INTERACT_1          = 4,                    //interaction wheel
  61     GOSSIP_ICON_INTERACT_2          = 5,                    //interaction wheel
  62     GOSSIP_ICON_MONEY_BAG           = 6,                    //brown bag with yellow dot
  63     GOSSIP_ICON_TALK                = 7,                    //white chat bubble with black dots
  64     GOSSIP_ICON_TABARD              = 8,                    //tabard
  65     GOSSIP_ICON_BATTLE              = 9,                    //two swords
  66     GOSSIP_ICON_DOT                 = 10,                   //yellow dot
  67     GOSSIP_ICON_MAX
  68 };
  69
  70 //POI icons. Many more exist, list not complete.
  71 enum Poi_Icon
  72 {
  73     ICON_POI_BLANK              =   0,                      // Blank (not visible), in 2.4.3 have value 15 with 1..15 values in 0..14 range
  74     ICON_POI_GREY_AV_MINE       =   1,                      // Grey mine lorry
  75     ICON_POI_RED_AV_MINE        =   2,                      // Red mine lorry
  76     ICON_POI_BLUE_AV_MINE       =   3,                      // Blue mine lorry
  77     ICON_POI_BWTOMB             =   4,                      // Blue and White Tomb Stone
  78     ICON_POI_SMALL_HOUSE        =   5,                      // Small house
  79     ICON_POI_GREYTOWER          =   6,                      // Grey Tower
  80     ICON_POI_REDFLAG            =   7,                      // Red Flag w/Yellow !
  81     ICON_POI_TOMBSTONE          =   8,                      // Normal tomb stone (brown)
  82     ICON_POI_BWTOWER            =   9,                      // Blue and White Tower
  83     ICON_POI_REDTOWER           =   10,                     // Red Tower
  84     ICON_POI_BLUETOWER          =   11,                     // Blue Tower
  85     ICON_POI_RWTOWER            =   12,                     // Red and White Tower
  86     ICON_POI_REDTOMB            =   13,                     // Red Tomb Stone
  87     ICON_POI_RWTOMB             =   14,                     // Red and White Tomb Stone
  88     ICON_POI_BLUETOMB           =   15,                     // Blue Tomb Stone
  89     ICON_POI_16                 =   16,                     // Grey ?
  90     ICON_POI_17                 =   17,                     // Blue/White ?
  91     ICON_POI_18                 =   18,                     // Blue ?
  92     ICON_POI_19                 =   19,                     // Red and White ?
  93     ICON_POI_20                 =   20,                     // Red ?
  94     ICON_POI_GREYLOGS           =   21,                     // Grey Wood Logs
  95     ICON_POI_BWLOGS             =   22,                     // Blue and White Wood Logs
  96     ICON_POI_BLUELOGS           =   23,                     // Blue Wood Logs
  97     ICON_POI_RWLOGS             =   24,                     // Red and White Wood Logs
  98     ICON_POI_REDLOGS            =   25,                     // Red Wood Logs
  99     ICON_POI_26                 =   26,                     // Grey ?
 100     ICON_POI_27                 =   27,                     // Blue and White ?
 101     ICON_POI_28                 =   28,                     // Blue ?
 102     ICON_POI_29                 =   29,                     // Red and White ?
 103     ICON_POI_30                 =   30,                     // Red ?
 104     ICON_POI_GREYHOUSE          =   31,                     // Grey House
 105     ICON_POI_BWHOUSE            =   32,                     // Blue and White House
 106     ICON_POI_BLUEHOUSE          =   33,                     // Blue House
 107     ICON_POI_RWHOUSE            =   34,                     // Red and White House
 108     ICON_POI_REDHOUSE           =   35,                     // Red House
 109     ICON_POI_GREYHORSE          =   36,                     // Grey Horse
 110     ICON_POI_BWHORSE            =   37,                     // Blue and White Horse
 111     ICON_POI_BLUEHORSE          =   38,                     // Blue Horse
 112     ICON_POI_RWHORSE            =   39,                     // Red and White Horse
 113     ICON_POI_REDHORSE           =   40                      // Red Horse
 114 };
 115
 116 struct GossipMenuItem
 117 {
 118     uint8       m_gIcon;
 119     bool        m_gCoded;
 120     std::string m_gMessage;
 121     uint32      m_gSender;
 122     uint32      m_gOptionId;
 123     std::string m_gBoxMessage;
 124     uint32      m_gBoxMoney;
 125 };
 126
 127 typedef std::vector<GossipMenuItem> GossipMenuItemList;
 128
 129 struct GossipMenuItemData
 130 {
 131     uint32 m_gAction_menu;
 132     uint32 m_gAction_poi;
 133     uint32 m_gAction_script;
 134 };
 135
 136 typedef std::vector<GossipMenuItemData> GossipMenuItemDataList;
 137
 138 struct QuestMenuItem
 139 {
 140     uint32      m_qId;
 141     uint8       m_qIcon;
 142 };
 143
 144 typedef std::vector<QuestMenuItem> QuestMenuItemList;
 145
 146 class MANGOS_DLL_SPEC GossipMenu
 147 {
 148     public:
 149         GossipMenu();
 150         ~GossipMenu();
 151
 152         void AddMenuItem(uint8 Icon, const std::string& Message, bool Coded = false);
 153         void AddMenuItem(uint8 Icon, const std::string& Message, uint32 dtSender, uint32 dtAction, const std::string& BoxMessage, uint32 BoxMoney, bool Coded = false);
 154
 155         // for using from scripts, don't must be inlined
 156         void AddMenuItem(uint8 Icon, char const* Message, bool Coded = false);
 157         void AddMenuItem(uint8 Icon, char const* Message, uint32 dtSender, uint32 dtAction, char const* BoxMessage, uint32 BoxMoney, bool Coded = false);
 158
 159         void SetMenuId(uint32 menu_id) { m_gMenuId = menu_id; }
 160         uint32 GetMenuId() { return m_gMenuId; }
 161
 162         void AddGossipMenuItemData(uint32 action_menu, uint32 action_poi, uint32 action_script);
 163
 164         unsigned int MenuItemCount() const
 165         {
 166             return m_gItems.size();
 167         }
 168
 169         bool Empty() const
 170         {
 171             return m_gItems.empty();
 172         }
 173
 174         GossipMenuItem const& GetItem( unsigned int Id )
 175         {
 176             return m_gItems[ Id ];
 177         }
 178
 179         GossipMenuItemData const& GetItemData(unsigned int indexId)
 180         {
 181             return m_gItemsData[indexId];
 182         }
 183
 184         uint32 MenuItemSender( unsigned int ItemId );
 185         uint32 MenuItemAction( unsigned int ItemId );
 186         bool MenuItemCoded( unsigned int ItemId );
 187
 188         void ClearMenu();
 189
 190     protected:
 191         GossipMenuItemList      m_gItems;
 192         GossipMenuItemDataList  m_gItemsData;
 193
 194         uint32 m_gMenuId;
 195 };
 196
 197 class QuestMenu
 198 {
 199     public:
 200         QuestMenu();
 201         ~QuestMenu();
 202
 203         void AddMenuItem( uint32 QuestId, uint8 Icon);
 204         void ClearMenu();
 205
 206         uint8 MenuItemCount() const
 207         {
 208             return m_qItems.size();
 209         }
 210
 211         bool Empty() const
 212         {
 213             return m_qItems.empty();
 214         }
 215
 216         bool HasItem( uint32 questid );
 217
 218         QuestMenuItem const& GetItem( uint16 Id )
 219         {
 220             return m_qItems[ Id ];
 221         }
 222
 223     protected:
 224         QuestMenuItemList m_qItems;
 225 };
 226
 227 class MANGOS_DLL_SPEC PlayerMenu
 228 {
 229     private:
 230         GossipMenu mGossipMenu;
 231         QuestMenu  mQuestMenu;
 232         WorldSession* pSession;
 233
 234     public:
 235         PlayerMenu( WorldSession *Session );
 236         ~PlayerMenu();
 237
 238         GossipMenu& GetGossipMenu() { return mGossipMenu; }
 239         QuestMenu& GetQuestMenu() { return mQuestMenu; }
 240
 241         bool Empty() const { return mGossipMenu.Empty() && mQuestMenu.Empty(); }
 242
 243         void ClearMenus();
 244         uint32 GossipOptionSender( unsigned int Selection );
 245         uint32 GossipOptionAction( unsigned int Selection );
 246         bool GossipOptionCoded( unsigned int Selection );
 247
 248         void SendGossipMenu( uint32 TitleTextId, uint64 npcGUID );
 249         void CloseGossip();
 250         void SendPointOfInterest( float X, float Y, uint32 Icon, uint32 Flags, uint32 Data, const char * locName );
 251         void SendPointOfInterest( uint32 poi_id );
 252         void SendTalking( uint32 textID );
 253         void SendTalking( char const * title, char const * text );
 254
 255         /*********************************************************/
 256         /***                    QUEST SYSTEM                   ***/
 257         /*********************************************************/
 258         void SendQuestGiverStatus( uint8 questStatus, uint64 npcGUID );
 259
 260         void SendQuestGiverQuestList( QEmote eEmote, const std::string& Title, uint64 npcGUID );
 261
 262         void SendQuestQueryResponse ( Quest const *pQuest );
 263         void SendQuestGiverQuestDetails( Quest const *pQuest, uint64 npcGUID, bool ActivateAccept);
 264
 265         void SendQuestGiverOfferReward( Quest const* pQuest, uint64 npcGUID, bool EnbleNext );
 266         void SendQuestGiverRequestItems( Quest const *pQuest, uint64 npcGUID, bool Completable, bool CloseOnCancel );
 267 };
 268 #endif