MiscObjects.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. #pragma once
  2. #include "CObjectHandler.h"
  3. #include "CArmedInstance.h"
  4. #include "../ResourceSet.h"
  5. /*
  6. * MiscObjects.h, part of VCMI engine
  7. *
  8. * Authors: listed in file AUTHORS in main folder
  9. *
  10. * License: GNU General Public License v2.0 or later
  11. * Full text of license available in license.txt file, in main folder
  12. *
  13. */
  14. class DLL_LINKAGE CPlayersVisited: public CGObjectInstance
  15. {
  16. public:
  17. std::set<PlayerColor> players; //players that visited this object
  18. bool wasVisited(PlayerColor player) const override;
  19. bool wasVisited(TeamID team) const;
  20. void setPropertyDer(ui8 what, ui32 val) override;
  21. template <typename Handler> void serialize(Handler &h, const int version)
  22. {
  23. h & static_cast<CGObjectInstance&>(*this);
  24. h & players;
  25. }
  26. };
  27. class DLL_LINKAGE CGCreature : public CArmedInstance //creatures on map
  28. {
  29. public:
  30. enum Action {
  31. FIGHT = -2, FLEE = -1, JOIN_FOR_FREE = 0 //values > 0 mean gold price
  32. };
  33. enum Character {
  34. COMPLIANT = 0, FRIENDLY = 1, AGRESSIVE = 2, HOSTILE = 3, SAVAGE = 4
  35. };
  36. ui32 identifier; //unique code for this monster (used in missions)
  37. si8 character; //character of this set of creatures (0 - the most friendly, 4 - the most hostile) => on init changed to -4 (compliant) ... 10 value (savage)
  38. std::string message; //message printed for attacking hero
  39. TResources resources; // resources given to hero that has won with monsters
  40. ArtifactID gainedArtifact; //ID of artifact gained to hero, -1 if none
  41. bool neverFlees; //if true, the troops will never flee
  42. bool notGrowingTeam; //if true, number of units won't grow
  43. ui64 temppower; //used to handle fractional stack growth for tiny stacks
  44. bool refusedJoining;
  45. void onHeroVisit(const CGHeroInstance * h) const override;
  46. std::string getHoverText(PlayerColor player) const override;
  47. std::string getHoverText(const CGHeroInstance * hero) const override;
  48. void initObj() override;
  49. void newTurn() const override;
  50. void battleFinished(const CGHeroInstance *hero, const BattleResult &result) const override;
  51. void blockingDialogAnswered(const CGHeroInstance *hero, ui32 answer) const override;
  52. //stack formation depends on position,
  53. bool containsUpgradedStack() const;
  54. int getNumberOfStacks(const CGHeroInstance *hero) const;
  55. struct DLL_LINKAGE formationInfo // info about merging stacks after battle back into one
  56. {
  57. si32 basicType;
  58. ui8 upgrade; //random seed used to determine number of stacks and is there's upgraded stack
  59. template <typename Handler> void serialize(Handler &h, const int version)
  60. {
  61. h & basicType & upgrade;
  62. }
  63. } formation;
  64. template <typename Handler> void serialize(Handler &h, const int version)
  65. {
  66. h & static_cast<CArmedInstance&>(*this);
  67. h & identifier & character & message & resources & gainedArtifact & neverFlees & notGrowingTeam & temppower;
  68. h & refusedJoining & formation;
  69. }
  70. protected:
  71. void setPropertyDer(ui8 what, ui32 val) override;
  72. private:
  73. void fight(const CGHeroInstance *h) const;
  74. void flee( const CGHeroInstance * h ) const;
  75. void fleeDecision(const CGHeroInstance *h, ui32 pursue) const;
  76. void joinDecision(const CGHeroInstance *h, int cost, ui32 accept) const;
  77. int takenAction(const CGHeroInstance *h, bool allowJoin=true) const; //action on confrontation: -2 - fight, -1 - flee, >=0 - will join for given value of gold (may be 0)
  78. };
  79. class DLL_LINKAGE CGSignBottle : public CGObjectInstance //signs and ocean bottles
  80. {
  81. public:
  82. std::string message;
  83. void onHeroVisit(const CGHeroInstance * h) const override;
  84. void initObj() override;
  85. template <typename Handler> void serialize(Handler &h, const int version)
  86. {
  87. h & static_cast<CGObjectInstance&>(*this);
  88. h & message;
  89. }
  90. };
  91. class DLL_LINKAGE CGWitchHut : public CPlayersVisited
  92. {
  93. public:
  94. std::vector<si32> allowedAbilities;
  95. ui32 ability;
  96. std::string getHoverText(PlayerColor player) const override;
  97. std::string getHoverText(const CGHeroInstance * hero) const override;
  98. void onHeroVisit(const CGHeroInstance * h) const override;
  99. void initObj() override;
  100. template <typename Handler> void serialize(Handler &h, const int version)
  101. {
  102. h & static_cast<CPlayersVisited&>(*this);
  103. h & allowedAbilities & ability;
  104. }
  105. };
  106. class DLL_LINKAGE CGScholar : public CGObjectInstance
  107. {
  108. public:
  109. enum EBonusType {PRIM_SKILL, SECONDARY_SKILL, SPELL, RANDOM = 255};
  110. EBonusType bonusType;
  111. ui16 bonusID; //ID of skill/spell
  112. // void giveAnyBonus(const CGHeroInstance * h) const; //TODO: remove
  113. CGScholar() : bonusType(EBonusType::RANDOM){};
  114. void onHeroVisit(const CGHeroInstance * h) const override;
  115. void initObj() override;
  116. template <typename Handler> void serialize(Handler &h, const int version)
  117. {
  118. h & static_cast<CGObjectInstance&>(*this);
  119. h & bonusType & bonusID;
  120. }
  121. };
  122. class DLL_LINKAGE CGGarrison : public CArmedInstance
  123. {
  124. public:
  125. bool removableUnits;
  126. bool passableFor(PlayerColor color) const override;
  127. void onHeroVisit(const CGHeroInstance * h) const override;
  128. void battleFinished(const CGHeroInstance *hero, const BattleResult &result) const override;
  129. template <typename Handler> void serialize(Handler &h, const int version)
  130. {
  131. h & static_cast<CArmedInstance&>(*this);
  132. h & removableUnits;
  133. }
  134. };
  135. class DLL_LINKAGE CGArtifact : public CArmedInstance
  136. {
  137. public:
  138. CArtifactInstance *storedArtifact;
  139. std::string message;
  140. CGArtifact() : CArmedInstance() {storedArtifact = nullptr;};
  141. void onHeroVisit(const CGHeroInstance * h) const override;
  142. void battleFinished(const CGHeroInstance *hero, const BattleResult &result) const override;
  143. void blockingDialogAnswered(const CGHeroInstance *hero, ui32 answer) const override;
  144. std::string getObjectName() const override;
  145. void pick( const CGHeroInstance * h ) const;
  146. void initObj() override;
  147. template <typename Handler> void serialize(Handler &h, const int version)
  148. {
  149. h & static_cast<CArmedInstance&>(*this);
  150. h & message & storedArtifact;
  151. }
  152. };
  153. class DLL_LINKAGE CGResource : public CArmedInstance
  154. {
  155. public:
  156. ui32 amount; //0 if random
  157. std::string message;
  158. CGResource();
  159. void onHeroVisit(const CGHeroInstance * h) const override;
  160. void initObj() override;
  161. void battleFinished(const CGHeroInstance *hero, const BattleResult &result) const override;
  162. void blockingDialogAnswered(const CGHeroInstance *hero, ui32 answer) const override;
  163. std::string getHoverText(PlayerColor player) const override;
  164. void collectRes(PlayerColor player) const;
  165. template <typename Handler> void serialize(Handler &h, const int version)
  166. {
  167. h & static_cast<CArmedInstance&>(*this);
  168. h & amount & message;
  169. }
  170. };
  171. class DLL_LINKAGE CGShrine : public CPlayersVisited
  172. {
  173. public:
  174. SpellID spell; //id of spell or NONE if random
  175. void onHeroVisit(const CGHeroInstance * h) const override;
  176. void initObj() override;
  177. std::string getHoverText(PlayerColor player) const override;
  178. std::string getHoverText(const CGHeroInstance * hero) const override;
  179. template <typename Handler> void serialize(Handler &h, const int version)
  180. {
  181. h & static_cast<CPlayersVisited&>(*this);;
  182. h & spell;
  183. }
  184. };
  185. class DLL_LINKAGE CGMine : public CArmedInstance
  186. {
  187. public:
  188. Res::ERes producedResource;
  189. ui32 producedQuantity;
  190. private:
  191. void onHeroVisit(const CGHeroInstance * h) const override;
  192. void battleFinished(const CGHeroInstance *hero, const BattleResult &result) const override;
  193. void blockingDialogAnswered(const CGHeroInstance *hero, ui32 answer) const override;
  194. void flagMine(PlayerColor player) const;
  195. void newTurn() const override;
  196. void initObj() override;
  197. std::string getObjectName() const override;
  198. std::string getHoverText(PlayerColor player) const override;
  199. public:
  200. template <typename Handler> void serialize(Handler &h, const int version)
  201. {
  202. h & static_cast<CArmedInstance&>(*this);
  203. h & producedResource & producedQuantity;
  204. }
  205. ui32 defaultResProduction();
  206. };
  207. struct DLL_LINKAGE TeleportChannel
  208. {
  209. enum EPassability {UNKNOWN, IMPASSABLE, PASSABLE};
  210. TeleportChannel() : passability(UNKNOWN) {}
  211. std::vector<ObjectInstanceID> entrances;
  212. std::vector<ObjectInstanceID> exits;
  213. EPassability passability;
  214. template <typename Handler> void serialize(Handler &h, const int version)
  215. {
  216. h & entrances & exits & passability;
  217. }
  218. };
  219. class DLL_LINKAGE CGTeleport : public CGObjectInstance
  220. {
  221. bool isChannelEntrance(ObjectInstanceID id) const;
  222. bool isChannelExit(ObjectInstanceID id) const;
  223. std::vector<ObjectInstanceID> getAllEntrances(bool excludeCurrent = false) const;
  224. protected:
  225. enum EType {UNKNOWN, ENTRANCE, EXIT, BOTH};
  226. EType type;
  227. CGTeleport();
  228. ObjectInstanceID getRandomExit(const CGHeroInstance * h) const;
  229. std::vector<ObjectInstanceID> getAllExits(bool excludeCurrent = false) const;
  230. public:
  231. TeleportChannelID channel;
  232. bool isEntrance() const;
  233. bool isExit() const;
  234. virtual void teleportDialogAnswered(const CGHeroInstance *hero, ui32 answer, TTeleportExitsList exits) const = 0;
  235. static bool isTeleport(const CGObjectInstance * dst);
  236. static bool isConnected(const CGTeleport * src, const CGTeleport * dst);
  237. static bool isConnected(const CGObjectInstance * src, const CGObjectInstance * dst);
  238. static void addToChannel(std::map<TeleportChannelID, std::shared_ptr<TeleportChannel> > &channelsList, const CGTeleport * obj);
  239. static std::vector<ObjectInstanceID> getPassableExits(CGameState * gs, const CGHeroInstance * h, std::vector<ObjectInstanceID> exits);
  240. static bool isExitPassable(CGameState * gs, const CGHeroInstance * h, const CGObjectInstance * obj);
  241. template <typename Handler> void serialize(Handler &h, const int version)
  242. {
  243. h & type & channel & static_cast<CGObjectInstance&>(*this);
  244. }
  245. };
  246. class DLL_LINKAGE CGMonolith : public CGTeleport
  247. {
  248. TeleportChannelID findMeChannel(std::vector<Obj> IDs, int SubID) const;
  249. protected:
  250. void onHeroVisit(const CGHeroInstance * h) const override;
  251. void teleportDialogAnswered(const CGHeroInstance *hero, ui32 answer, TTeleportExitsList exits) const override;
  252. void initObj() override;
  253. public:
  254. template <typename Handler> void serialize(Handler &h, const int version)
  255. {
  256. h & static_cast<CGTeleport&>(*this);
  257. }
  258. };
  259. class DLL_LINKAGE CGSubterraneanGate : public CGMonolith
  260. {
  261. void onHeroVisit(const CGHeroInstance * h) const override;
  262. void initObj() override;
  263. public:
  264. static void postInit();
  265. template <typename Handler> void serialize(Handler &h, const int version)
  266. {
  267. h & static_cast<CGMonolith&>(*this);
  268. }
  269. };
  270. class DLL_LINKAGE CGWhirlpool : public CGMonolith
  271. {
  272. void onHeroVisit(const CGHeroInstance * h) const override;
  273. void teleportDialogAnswered(const CGHeroInstance *hero, ui32 answer, TTeleportExitsList exits) const override;
  274. static bool isProtected( const CGHeroInstance * h );
  275. public:
  276. template <typename Handler> void serialize(Handler &h, const int version)
  277. {
  278. h & static_cast<CGMonolith&>(*this);
  279. }
  280. };
  281. class DLL_LINKAGE CGMagicWell : public CGObjectInstance //objects giving bonuses to luck/morale/movement
  282. {
  283. public:
  284. void onHeroVisit(const CGHeroInstance * h) const override;
  285. std::string getHoverText(const CGHeroInstance * hero) const override;
  286. template <typename Handler> void serialize(Handler &h, const int version)
  287. {
  288. h & static_cast<CGObjectInstance&>(*this);
  289. }
  290. };
  291. class DLL_LINKAGE CGSirens : public CGObjectInstance
  292. {
  293. public:
  294. void onHeroVisit(const CGHeroInstance * h) const override;
  295. std::string getHoverText(const CGHeroInstance * hero) const override;
  296. void initObj() override;
  297. template <typename Handler> void serialize(Handler &h, const int version)
  298. {
  299. h & static_cast<CGObjectInstance&>(*this);
  300. }
  301. };
  302. class DLL_LINKAGE CGObservatory : public CGObjectInstance //Redwood observatory
  303. {
  304. public:
  305. void onHeroVisit(const CGHeroInstance * h) const override;
  306. template <typename Handler> void serialize(Handler &h, const int version)
  307. {
  308. h & static_cast<CGObjectInstance&>(*this);
  309. }
  310. };
  311. class DLL_LINKAGE CGBoat : public CGObjectInstance
  312. {
  313. public:
  314. ui8 direction;
  315. const CGHeroInstance *hero; //hero on board
  316. void initObj() override;
  317. CGBoat()
  318. {
  319. hero = nullptr;
  320. direction = 4;
  321. }
  322. template <typename Handler> void serialize(Handler &h, const int version)
  323. {
  324. h & static_cast<CGObjectInstance&>(*this) & direction & hero;
  325. }
  326. };
  327. class CGShipyard : public CGObjectInstance, public IShipyard
  328. {
  329. public:
  330. void getOutOffsets(std::vector<int3> &offsets) const override; //offsets to obj pos when we boat can be placed
  331. CGShipyard();
  332. void onHeroVisit(const CGHeroInstance * h) const override;
  333. template <typename Handler> void serialize(Handler &h, const int version)
  334. {
  335. h & static_cast<CGObjectInstance&>(*this);
  336. h & static_cast<IShipyard&>(*this);
  337. }
  338. };
  339. class DLL_LINKAGE CGMagi : public CGObjectInstance
  340. {
  341. public:
  342. static std::map <si32, std::vector<ObjectInstanceID> > eyelist; //[subID][id], supports multiple sets as in H5
  343. void initObj() override;
  344. void onHeroVisit(const CGHeroInstance * h) const override;
  345. template <typename Handler> void serialize(Handler &h, const int version)
  346. {
  347. h & static_cast<CGObjectInstance&>(*this);
  348. }
  349. };
  350. class DLL_LINKAGE CCartographer : public CPlayersVisited
  351. {
  352. ///behaviour varies depending on surface and floor
  353. public:
  354. void onHeroVisit(const CGHeroInstance * h) const override;
  355. void blockingDialogAnswered(const CGHeroInstance *hero, ui32 answer) const override;
  356. template <typename Handler> void serialize(Handler &h, const int version)
  357. {
  358. h & static_cast<CPlayersVisited&>(*this);
  359. }
  360. };
  361. class DLL_LINKAGE CGDenOfthieves : public CGObjectInstance
  362. {
  363. void onHeroVisit(const CGHeroInstance * h) const override;
  364. };
  365. class DLL_LINKAGE CGObelisk : public CPlayersVisited
  366. {
  367. public:
  368. static ui8 obeliskCount; //how many obelisks are on map
  369. static std::map<TeamID, ui8> visited; //map: team_id => how many obelisks has been visited
  370. void onHeroVisit(const CGHeroInstance * h) const override;
  371. void initObj() override;
  372. std::string getHoverText(PlayerColor player) const override;
  373. template <typename Handler> void serialize(Handler &h, const int version)
  374. {
  375. h & static_cast<CPlayersVisited&>(*this);
  376. }
  377. protected:
  378. void setPropertyDer(ui8 what, ui32 val) override;
  379. };
  380. class DLL_LINKAGE CGLighthouse : public CGObjectInstance
  381. {
  382. public:
  383. void onHeroVisit(const CGHeroInstance * h) const override;
  384. void initObj() override;
  385. std::string getHoverText(PlayerColor player) const override;
  386. template <typename Handler> void serialize(Handler &h, const int version)
  387. {
  388. h & static_cast<CGObjectInstance&>(*this);
  389. }
  390. void giveBonusTo( PlayerColor player ) const;
  391. };