Quests.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  1. /*
  2. EQ2Emulator: Everquest II Server Emulator
  3. Copyright (C) 2007 EQ2EMulator Development Team (http://www.eq2emulator.net)
  4. This file is part of EQ2Emulator.
  5. EQ2Emulator is free software: you can redistribute it and/or modify
  6. it under the terms of the GNU General Public License as published by
  7. the Free Software Foundation, either version 3 of the License, or
  8. (at your option) any later version.
  9. EQ2Emulator 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. You should have received a copy of the GNU General Public License
  14. along with EQ2Emulator. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #ifndef QUESTS_H
  17. #define QUESTS_H
  18. #include <map>
  19. #include <vector>
  20. #include "Items/Items.h"
  21. #define QUEST_STEP_TYPE_KILL 1
  22. #define QUEST_STEP_TYPE_CHAT 2
  23. #define QUEST_STEP_TYPE_OBTAIN_ITEM 3
  24. #define QUEST_STEP_TYPE_LOCATION 4
  25. #define QUEST_STEP_TYPE_SPELL 5
  26. #define QUEST_STEP_TYPE_NORMAL 6
  27. #define QUEST_STEP_TYPE_CRAFT 7
  28. #define QUEST_STEP_TYPE_HARVEST 8
  29. #define QUEST_STEP_TYPE_KILL_RACE_REQ 9 // kill using race type requirement instead of npc db id
  30. #define QUEST_DISPLAY_STATUS_HIDDEN 0
  31. #define QUEST_DISPLAY_STATUS_NO_CHECK 1
  32. #define QUEST_DISPLAY_STATUS_YELLOW 2
  33. #define QUEST_DISPLAY_STATUS_COMPLETED 4
  34. #define QUEST_DISPLAY_STATUS_REPEATABLE 8
  35. #define QUEST_DISPLAY_STATUS_UNKNOWN1 16
  36. #define QUEST_DISPLAY_STATUS_COMPLETE_FLAG 32
  37. #define QUEST_DISPLAY_STATUS_UNKNOWN2 64
  38. #define QUEST_DISPLAY_STATUS_CHECK 128
  39. // Almost all quests have these values, but they don't see to effect anything
  40. #define QUEST_DISPLAY_STATUS_NORMAL QUEST_DISPLAY_STATUS_UNKNOWN1 + QUEST_DISPLAY_STATUS_UNKNOWN2
  41. struct QuestFactionPrereq{
  42. int32 faction_id;
  43. sint32 min;
  44. sint32 max;
  45. };
  46. struct Location {
  47. int32 id;
  48. float x;
  49. float y;
  50. float z;
  51. int32 zone_id;
  52. };
  53. class QuestStep{
  54. public:
  55. QuestStep(int32 in_id, int8 in_type, string in_description, vector<int32>* in_ids, int32 in_quantity, const char* in_task_group, vector<Location>* in_locations, float in_max_variation, float in_percentage, int32 in_usableitemid);
  56. QuestStep(QuestStep* old_step);
  57. ~QuestStep();
  58. bool CheckStepKillRaceReqUpdate(Spawn* spawn);
  59. bool CheckStepReferencedID(int32 id);
  60. bool CheckStepLocationUpdate(float char_x, float char_y, float char_z, int32 zone_id);
  61. int32 AddStepProgress(int32 val);
  62. void SetStepProgress(int32 val);
  63. int32 GetStepProgress();
  64. int8 GetStepType();
  65. bool Complete();
  66. void SetComplete();
  67. void ResetTaskGroup();
  68. const char* GetTaskGroup();
  69. const char* GetDescription();
  70. void SetDescription(string desc);
  71. int16 GetQuestCurrentQuantity();
  72. int16 GetQuestNeededQuantity();
  73. map<int32, bool>* GetUpdateIDs() { return ids; }
  74. int16 GetIcon();
  75. void SetIcon(int16 in_icon);
  76. const char* GetUpdateTargetName();
  77. void SetUpdateTargetName(const char* name);
  78. const char* GetUpdateName();
  79. void SetUpdateName(const char* name);
  80. int32 GetStepID();
  81. int32 GetItemID();
  82. bool WasUpdated();
  83. void WasUpdated(bool val);
  84. float GetPercentage();
  85. void SetTaskGroup(string val) { task_group = val; }
  86. private:
  87. bool updated;
  88. int32 id;
  89. string update_name;
  90. string update_target_name;
  91. int16 icon;
  92. int8 type;
  93. string description;
  94. std::map<int32, bool>* ids;
  95. int32 quantity;
  96. string task_group;
  97. vector<Location>* locations;
  98. float max_variation;
  99. float percentage;
  100. int32 usableitemid;
  101. int32 step_progress;
  102. };
  103. class Player;
  104. class Spell;
  105. class Quest{
  106. public:
  107. Quest(int32 in_id);
  108. Quest(Quest* old_quest);
  109. ~Quest();
  110. EQ2Packet* OfferQuest(int16 version, Player* player);
  111. EQ2Packet* QuestJournalReply(int16 version, int32 player_crc, Player* player, QuestStep* updateStep = 0, int8 update_count = 1, bool old_completed_quest=false, bool quest_failure = false, bool display_quest_helper = true);
  112. void RegisterQuest(string in_name, string in_type, string in_zone, int8 in_level, string in_desc);
  113. void SetPrereqLevel(int8 lvl);
  114. void SetPrereqTSLevel(int8 lvl);
  115. void SetPrereqMaxLevel(int8 lvl) {prereq_max_level = lvl;}
  116. void SetPrereqMaxTSLevel(int8 lvl) {prereq_max_tslevel = lvl;}
  117. void AddPrereqClass(int8 class_id);
  118. void AddPrereqTradeskillClass(int8 class_id);
  119. void AddPrereqModelType(int16 model_type);
  120. void AddPrereqRace(int8 race);
  121. void AddPrereqQuest(int32 quest_id);
  122. void AddPrereqFaction(int32 faction_id, sint32 min, sint32 max = 0);
  123. void AddPrereqItem(Item* item);
  124. void AddRewardItem(Item* item);
  125. void AddTmpRewardItem(Item* item);
  126. void GetTmpRewardItemsByID(std::vector<int32>* items);
  127. void AddSelectableRewardItem(Item* item);
  128. void AddRewardCoins(int32 copper, int32 silver, int32 gold, int32 plat);
  129. void AddRewardCoinsMax(int64 coins);
  130. void AddRewardFaction(int32 faction_id, sint32 amount);
  131. void SetRewardStatus(int32 amount);
  132. void SetRewardComment(string comment);
  133. void SetRewardXP(int32 xp);
  134. void SetRewardTSXP(int32 xp) { reward_tsexp = xp; }
  135. bool AddQuestStep(QuestStep* step);
  136. QuestStep* AddQuestStep(int32 id, int8 in_type, string in_description, vector<int32>* in_ids, int32 in_quantity, const char* in_task_group = 0, vector<Location>* in_locations = 0, float in_max_variation = 0, float in_percentage = 0,int32 in_usableitemid = 0);
  137. bool SetStepComplete(int32 step);
  138. bool AddStepProgress(int32 step_id, int32 progress);
  139. int16 GetQuestStep();
  140. int32 GetStepProgress(int32 step_id);
  141. int16 GetTaskGroupStep();
  142. bool QuestStepIsActive(int16 quest_step_id);
  143. bool CheckQuestReferencedSpawns(Spawn* spawn);
  144. bool CheckQuestKillUpdate(Spawn* spawn, bool update = true);
  145. bool CheckQuestChatUpdate(int32 id, bool update = true);
  146. bool CheckQuestItemUpdate(int32 id, int8 quantity = 1);
  147. bool CheckQuestLocationUpdate(float char_x, float char_y, float char_z, int32 zone_id);
  148. bool CheckQuestSpellUpdate(Spell* spell);
  149. bool CheckQuestRefIDUpdate(int32 id, int32 quantity = 1);
  150. int8 GetQuestLevel();
  151. int8 GetVisible();
  152. int32 GetQuestID();
  153. void SetQuestID(int32 in_id);
  154. int8 GetPrereqLevel();
  155. int8 GetPrereqTSLevel();
  156. int8 GetPrereqMaxLevel() {return prereq_max_level;}
  157. int8 GetPrereqMaxTSLevel() {return prereq_max_tslevel;}
  158. vector<QuestFactionPrereq>* GetPrereqFactions();
  159. vector<int8>* GetPrereqRaces();
  160. vector<int16>* GetPrereqModelTypes();
  161. vector<int8>* GetPrereqClasses();
  162. vector<int8>* GetPrereqTradeskillClasses();
  163. vector<int32>* GetPrereqQuests();
  164. vector<Item*>* GetPrereqItems();
  165. vector<Item*>* GetRewardItems();
  166. vector<Item*>* GetTmpRewardItems();
  167. vector<Item*>* GetSelectableRewardItems();
  168. map<int32, sint32>* GetRewardFactions();
  169. void GiveQuestReward(Player* player);
  170. void AddCompleteAction(int32 step, string action);
  171. void AddProgressAction(int32 step, string action);
  172. void SetName(string in_name);
  173. void SetType(string in_type);
  174. void SetLevel(int8 in_level);
  175. void SetEncounterLevel(int8 level) {enc_level = level;}
  176. void SetDescription(string desc);
  177. void SetStepDescription(int32 step, string desc);
  178. void SetTaskGroupDescription(int32 step, string desc, bool display_bullets);
  179. void SetStatusTmpReward(int32 status) { tmp_reward_status = status; }
  180. int64 GetStatusTmpReward() { return tmp_reward_status; }
  181. void SetCoinTmpReward(int64 coins) { tmp_reward_coins = coins; }
  182. int64 GetCoinTmpReward() { return tmp_reward_coins; }
  183. int64 GetCoinsReward();
  184. int64 GetCoinsRewardMax();
  185. int64 GetGeneratedCoin();
  186. void SetGeneratedCoin(int64 coin);
  187. int8 GetLevel();
  188. int8 GetEncounterLevel() { return enc_level; }
  189. const char* GetName();
  190. const char* GetDescription();
  191. const char* GetType();
  192. void SetZone(string in_zone);
  193. const char* GetZone();
  194. int8 GetDay();
  195. int8 GetMonth();
  196. int8 GetYear();
  197. int32 GetStatusPoints();
  198. void SetDay(int8 value);
  199. void SetMonth(int8 value);
  200. void SetYear(int8 value);
  201. vector<QuestStep*>* GetQuestUpdates();
  202. vector<QuestStep*>* GetQuestFailures();
  203. vector<QuestStep*>* GetQuestSteps();
  204. bool GetQuestStepCompleted(int32 step_id);
  205. QuestStep* GetQuestStep(int32 step_id);
  206. void SetCompleteAction(string action);
  207. const char* GetCompleteAction();
  208. const char* GetCompleteAction(int32 step);
  209. void SetQuestGiver(int32 id);
  210. int32 GetQuestGiver();
  211. void SetQuestReturnNPC(int32 id);
  212. int32 GetQuestReturnNPC();
  213. Player* GetPlayer();
  214. void SetPlayer(Player* in_player);
  215. bool GetCompleted();
  216. bool HasSentLastUpdate() { return has_sent_last_update; }
  217. void SetSentLastUpdate(bool val) { has_sent_last_update = val; }
  218. void SetCompletedDescription(string desc);
  219. const char* GetCompletedDescription();
  220. int32 GetExpReward();
  221. int32 GetTSExpReward() { return reward_tsexp; }
  222. bool GetDeleted();
  223. void SetDeleted(bool val);
  224. bool GetUpdateRequired();
  225. void SetUpdateRequired(bool val);
  226. void SetTurnedIn(bool val);
  227. bool GetTurnedIn();
  228. bool GetSaveNeeded(){ return needs_save; }
  229. void SetSaveNeeded(bool val){ needs_save = val; }
  230. void SetFeatherColor(int8 val) { m_featherColor = val; }
  231. int8 GetFeatherColor() { return m_featherColor; }
  232. void SetRepeatable(bool val) { m_repeatable = val; }
  233. bool IsRepeatable() { return m_repeatable; }
  234. void SetTracked(bool val) { m_tracked = val; }
  235. bool IsTracked() { return m_tracked && !m_hidden; }
  236. void SetCompletedFlag(bool val);
  237. bool GetCompletedFlag() {return completed_flag;}
  238. bool GetYellowName() {return yellow_name;}
  239. void SetYellowName(bool val) {yellow_name = val;}
  240. bool CheckCategoryYellow();
  241. ///<summary>Sets the custom flags for use in lua</summary>
  242. ///<param name='flags'>Value to set the flags to</param>
  243. void SetQuestFlags(int32 flags) { m_questFlags = flags; SetSaveNeeded(true); }
  244. ///<summary>Gets the custom lua flags</summary>
  245. ///<returns>The current flags (int32)</returns>
  246. int32 GetQuestFlags() { return m_questFlags; }
  247. ///<summary>Checks to see if the quest is hidden</summary>
  248. ///<returns>True if the quest is hidden</returns>
  249. bool IsHidden() { return m_hidden; }
  250. ///<summary>Sets the quest hidden flag</summary>
  251. ///<param name='val'>Value to set the hidden flag to</param>
  252. void SetHidden(bool val) { m_hidden = val; SetSaveNeeded(true); }
  253. ///<summary>Gets the step timer</summary>
  254. ///<returns>Unix timestamp (int32)</returns>
  255. int32 GetStepTimer() { return m_timestamp; }
  256. ///<summary>Sets the step timer</summary>
  257. ///<param name='duration'>How long to set the timer for, in seconds</param>
  258. void SetStepTimer(int32 duration);
  259. ///<summary>Sets the step that the timer is for</summary>
  260. ///<param name='step'>Step to set the timer for</param>
  261. void SetTimerStep(int32 step) { m_timerStep = step; }
  262. ///<summary>Gets the step that the timer is for</summary>
  263. int32 GetTimerStep() { return m_timerStep; }
  264. ///<summary>Adds a lua call back function for when the step fails</summary>
  265. ///<param name='step'>The step to add the call back for</param>
  266. ///<param name='action'>The lua callback function</param>
  267. void AddFailedAction(int32 step, string action);
  268. ///<summary>Fail the given step</summary>
  269. ///<param name='step'>The step to fail</param>
  270. void StepFailed(int32 step);
  271. ///<summary>Removes the given step from the quest</summary>
  272. ///<param name='step'>The step id to remove</param>
  273. ///<param name='client'>The client who has this quest</param>
  274. ///<returns>True if able to remove the quest</returns>
  275. bool RemoveQuestStep(int32 step, Client* client);
  276. int16 GetCompleteCount() { return m_completeCount; }
  277. void SetCompleteCount(int16 val) { m_completeCount = val; }
  278. void IncrementCompleteCount() { m_completeCount += 1; }
  279. void SetQuestTemporaryState(bool tempState, std::string customDescription = string(""));
  280. bool GetQuestTemporaryState() { return quest_state_temporary; }
  281. std::string GetQuestTemporaryDescription() { return quest_temporary_description; }
  282. protected:
  283. bool needs_save;
  284. Mutex MQuestSteps;
  285. Mutex MCompletedActions;
  286. Mutex MProgressActions;
  287. Mutex MFailedActions;
  288. bool turned_in;
  289. bool update_needed;
  290. bool deleted;
  291. bool has_sent_last_update;
  292. string completed_description;
  293. map<int32, string> complete_actions;
  294. map<int32, string> progress_actions;
  295. map<int32, string> failed_actions;
  296. int8 day; //only here to make our lives easier
  297. int8 month;
  298. int8 year;
  299. int8 visible;
  300. int32 id;
  301. string name;
  302. string type;
  303. string zone;
  304. int8 level;
  305. int8 enc_level;
  306. string description;
  307. string complete_action;
  308. Player* player;
  309. vector<QuestFactionPrereq> prereq_factions;
  310. int8 prereq_level;
  311. int8 prereq_tslevel;
  312. int8 prereq_max_level;
  313. int8 prereq_max_tslevel;
  314. vector<int16> prereq_model_types;
  315. vector<int8> prereq_races;
  316. vector<int8> prereq_classes;
  317. vector<int8> prereq_tradeskillclass;
  318. vector<int32> prereq_quests;
  319. vector<Item*> prereq_items;
  320. vector<Item*> reward_items;
  321. vector<Item*> selectable_reward_items;
  322. vector<Item*> tmp_reward_items;
  323. int64 reward_coins;
  324. int64 reward_coins_max;
  325. int32 tmp_reward_status;
  326. int64 tmp_reward_coins;
  327. int64 generated_coin;
  328. map<int32, sint32> reward_factions;
  329. int32 reward_status;
  330. string reward_comment;
  331. int32 reward_exp;
  332. int32 reward_tsexp;
  333. vector<QuestStep*> step_updates;
  334. vector<QuestStep*> step_failures;
  335. map<int32, QuestStep*> quest_step_map;
  336. map<QuestStep*, int32> quest_step_reverse_map;
  337. vector<QuestStep*> quest_steps;
  338. map<int16, string> task_group_order;
  339. int16 task_group_num;
  340. map<string, vector<QuestStep*> > task_group;
  341. int32 quest_giver;
  342. int32 return_id;
  343. int8 m_featherColor;
  344. bool m_repeatable;
  345. bool m_tracked;
  346. bool completed_flag;
  347. bool yellow_name;
  348. int32 m_questFlags;
  349. bool m_hidden;
  350. int32 m_timestamp; // timer for a quest step
  351. int32 m_timerStep; // used for the fail action when timer expires
  352. int16 m_completeCount;
  353. bool quest_state_temporary;
  354. std::string quest_temporary_description;
  355. };
  356. class MasterQuestList{
  357. public:
  358. MasterQuestList();
  359. Quest* GetQuest(int32 id, bool copyQuest = true){
  360. if(quests.count(id) > 0)
  361. {
  362. if(copyQuest)
  363. return new Quest(quests[id]);
  364. else
  365. return quests[id];
  366. }
  367. else
  368. return 0;
  369. }
  370. map<int32, Quest*>* GetQuests(){
  371. return &quests;
  372. }
  373. void AddQuest(int32 id, Quest* quest){
  374. quests[id] = quest;
  375. }
  376. void Reload();
  377. void LockQuests();
  378. void UnlockQuests();
  379. private:
  380. Mutex MQuests;
  381. map<int32, Quest*> quests;
  382. };
  383. #endif