GameConstants.h 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383
  1. /*
  2. * GameConstants.h, part of VCMI engine
  3. *
  4. * Authors: listed in file AUTHORS in main folder
  5. *
  6. * License: GNU General Public License v2.0 or later
  7. * Full text of license available in license.txt file, in main folder
  8. *
  9. */
  10. #pragma once
  11. #include "ConstTransitivePtr.h"
  12. VCMI_LIB_NAMESPACE_BEGIN
  13. class Artifact;
  14. class ArtifactService;
  15. class Creature;
  16. class CreatureService;
  17. namespace spells
  18. {
  19. class Spell;
  20. class Service;
  21. }
  22. class CArtifact;
  23. class CArtifactInstance;
  24. class CCreature;
  25. class CHero;
  26. class CSpell;
  27. class CSkill;
  28. class CGameInfoCallback;
  29. class CNonConstInfoCallback;
  30. struct IdTag
  31. {};
  32. namespace GameConstants
  33. {
  34. DLL_LINKAGE extern const std::string VCMI_VERSION;
  35. constexpr int PUZZLE_MAP_PIECES = 48;
  36. constexpr int MAX_HEROES_PER_PLAYER = 8;
  37. constexpr int AVAILABLE_HEROES_PER_PLAYER = 2;
  38. constexpr int ALL_PLAYERS = 255; //bitfield
  39. constexpr int CREATURES_PER_TOWN = 7; //without upgrades
  40. constexpr int SPELL_LEVELS = 5;
  41. constexpr int SPELL_SCHOOL_LEVELS = 4;
  42. constexpr int DEFAULT_SCHOOLS = 4;
  43. constexpr int CRE_LEVELS = 10; // number of creature experience levels
  44. constexpr int HERO_GOLD_COST = 2500;
  45. constexpr int SPELLBOOK_GOLD_COST = 500;
  46. constexpr int SKILL_GOLD_COST = 2000;
  47. constexpr int BATTLE_SHOOTING_PENALTY_DISTANCE = 10; //if the distance is > than this, then shooting stack has distance penalty
  48. constexpr int BATTLE_SHOOTING_RANGE_DISTANCE = std::numeric_limits<uint8_t>::max(); // used when shooting stack has no shooting range limit
  49. constexpr int ARMY_SIZE = 7;
  50. constexpr int SKILL_PER_HERO = 8;
  51. constexpr ui32 HERO_HIGH_LEVEL = 10; // affects primary skill upgrade order
  52. constexpr int SKILL_QUANTITY=28;
  53. constexpr int PRIMARY_SKILLS=4;
  54. constexpr int RESOURCE_QUANTITY=8;
  55. constexpr int HEROES_PER_TYPE=8; //amount of heroes of each type
  56. // amounts of OH3 objects. Can be changed by mods, should be used only during H3 loading phase
  57. constexpr int F_NUMBER = 9;
  58. constexpr int ARTIFACTS_QUANTITY=171;
  59. constexpr int HEROES_QUANTITY=156;
  60. constexpr int SPELLS_QUANTITY=70;
  61. constexpr int CREATURES_COUNT = 197;
  62. constexpr ui32 BASE_MOVEMENT_COST = 100; //default cost for non-diagonal movement
  63. constexpr int HERO_PORTRAIT_SHIFT = 9;// 2 special frames + 7 extra portraits
  64. constexpr std::array<int, 11> POSSIBLE_TURNTIME = {1, 2, 4, 6, 8, 10, 15, 20, 25, 30, 0};
  65. }
  66. #define ID_LIKE_CLASS_COMMON(CLASS_NAME, ENUM_NAME) \
  67. constexpr CLASS_NAME(const CLASS_NAME & other) = default; \
  68. constexpr CLASS_NAME & operator=(const CLASS_NAME & other) = default; \
  69. explicit constexpr CLASS_NAME(si32 id) \
  70. : num(static_cast<ENUM_NAME>(id)) \
  71. {} \
  72. constexpr operator ENUM_NAME() const \
  73. { \
  74. return num; \
  75. } \
  76. constexpr si32 getNum() const \
  77. { \
  78. return static_cast<si32>(num); \
  79. } \
  80. constexpr ENUM_NAME toEnum() const \
  81. { \
  82. return num; \
  83. } \
  84. template <typename Handler> void serialize(Handler &h, const int version) \
  85. { \
  86. h & num; \
  87. } \
  88. constexpr CLASS_NAME & advance(int i) \
  89. { \
  90. num = static_cast<ENUM_NAME>(static_cast<int>(num) + i); \
  91. return *this; \
  92. }
  93. // Operators are performance-critical and to be inlined they must be in header
  94. #define ID_LIKE_OPERATORS_INTERNAL(A, B, AN, BN) \
  95. STRONG_INLINE constexpr bool operator==(const A & a, const B & b) \
  96. { \
  97. return AN == BN ; \
  98. } \
  99. STRONG_INLINE constexpr bool operator!=(const A & a, const B & b) \
  100. { \
  101. return AN != BN ; \
  102. } \
  103. STRONG_INLINE constexpr bool operator<(const A & a, const B & b) \
  104. { \
  105. return AN < BN ; \
  106. } \
  107. STRONG_INLINE constexpr bool operator<=(const A & a, const B & b) \
  108. { \
  109. return AN <= BN ; \
  110. } \
  111. STRONG_INLINE constexpr bool operator>(const A & a, const B & b) \
  112. { \
  113. return AN > BN ; \
  114. } \
  115. STRONG_INLINE constexpr bool operator>=(const A & a, const B & b) \
  116. { \
  117. return AN >= BN ; \
  118. }
  119. #define ID_LIKE_OPERATORS(CLASS_NAME, ENUM_NAME) \
  120. ID_LIKE_OPERATORS_INTERNAL(CLASS_NAME, CLASS_NAME, a.num, b.num) \
  121. ID_LIKE_OPERATORS_INTERNAL(CLASS_NAME, ENUM_NAME, a.num, b) \
  122. ID_LIKE_OPERATORS_INTERNAL(ENUM_NAME, CLASS_NAME, a, b.num)
  123. #define INSTID_LIKE_CLASS_COMMON(CLASS_NAME, NUMERIC_NAME) \
  124. public: \
  125. constexpr CLASS_NAME(const CLASS_NAME & other): \
  126. BaseForID<CLASS_NAME, NUMERIC_NAME>(other) \
  127. { \
  128. } \
  129. constexpr CLASS_NAME & operator=(const CLASS_NAME & other) = default; \
  130. constexpr CLASS_NAME & operator=(NUMERIC_NAME other) { num = other; return *this; }; \
  131. explicit constexpr CLASS_NAME(si32 id = -1) \
  132. : BaseForID<CLASS_NAME, NUMERIC_NAME>(id) \
  133. {}
  134. template < typename Derived, typename NumericType>
  135. class BaseForID : public IdTag
  136. {
  137. protected:
  138. NumericType num;
  139. public:
  140. constexpr NumericType getNum() const
  141. {
  142. return num;
  143. }
  144. //to make it more similar to IDLIKE
  145. constexpr NumericType toEnum() const
  146. {
  147. return num;
  148. }
  149. template <typename Handler> void serialize(Handler &h, const int version)
  150. {
  151. h & num;
  152. }
  153. constexpr explicit BaseForID(NumericType _num = -1) :
  154. num(_num)
  155. {
  156. }
  157. constexpr void advance(int change)
  158. {
  159. num += change;
  160. }
  161. constexpr bool operator == (const BaseForID & b) const { return num == b.num; }
  162. constexpr bool operator <= (const BaseForID & b) const { return num <= b.num; }
  163. constexpr bool operator >= (const BaseForID & b) const { return num >= b.num; }
  164. constexpr bool operator != (const BaseForID & b) const { return num != b.num; }
  165. constexpr bool operator < (const BaseForID & b) const { return num < b.num; }
  166. constexpr bool operator > (const BaseForID & b) const { return num > b.num; }
  167. constexpr BaseForID & operator++() { ++num; return *this; }
  168. constexpr operator NumericType() const
  169. {
  170. return num;
  171. }
  172. };
  173. template < typename T>
  174. class Identifier : public IdTag
  175. {
  176. public:
  177. using EnumType = T;
  178. using NumericType = typename std::underlying_type<EnumType>::type;
  179. private:
  180. NumericType num;
  181. public:
  182. constexpr NumericType getNum() const
  183. {
  184. return num;
  185. }
  186. constexpr EnumType toEnum() const
  187. {
  188. return static_cast<EnumType>(num);
  189. }
  190. template <typename Handler> void serialize(Handler &h, const int version)
  191. {
  192. h & num;
  193. }
  194. constexpr explicit Identifier(NumericType _num = -1)
  195. {
  196. num = _num;
  197. }
  198. /* implicit */constexpr Identifier(EnumType _num):
  199. num(static_cast<NumericType>(_num))
  200. {
  201. }
  202. constexpr void advance(int change)
  203. {
  204. num += change;
  205. }
  206. constexpr bool operator == (const Identifier & b) const { return num == b.num; }
  207. constexpr bool operator <= (const Identifier & b) const { return num <= b.num; }
  208. constexpr bool operator >= (const Identifier & b) const { return num >= b.num; }
  209. constexpr bool operator != (const Identifier & b) const { return num != b.num; }
  210. constexpr bool operator < (const Identifier & b) const { return num < b.num; }
  211. constexpr bool operator > (const Identifier & b) const { return num > b.num; }
  212. constexpr Identifier & operator++()
  213. {
  214. ++num;
  215. return *this;
  216. }
  217. constexpr Identifier operator++(int)
  218. {
  219. Identifier ret(*this);
  220. ++num;
  221. return ret;
  222. }
  223. constexpr operator NumericType() const
  224. {
  225. return num;
  226. }
  227. };
  228. template<typename Der, typename Num>
  229. std::ostream & operator << (std::ostream & os, BaseForID<Der, Num> id);
  230. template<typename Der, typename Num>
  231. std::ostream & operator << (std::ostream & os, BaseForID<Der, Num> id)
  232. {
  233. //We use common type with short to force char and unsigned char to be promoted and formatted as numbers.
  234. typedef typename std::common_type<short, Num>::type Number;
  235. return os << static_cast<Number>(id.getNum());
  236. }
  237. template<typename EnumType>
  238. std::ostream & operator << (std::ostream & os, Identifier<EnumType> id)
  239. {
  240. //We use common type with short to force char and unsigned char to be promoted and formatted as numbers.
  241. typedef typename std::common_type<short, typename Identifier<EnumType>::NumericType>::type Number;
  242. return os << static_cast<Number>(id.getNum());
  243. }
  244. class ArtifactInstanceID : public BaseForID<ArtifactInstanceID, si32>
  245. {
  246. INSTID_LIKE_CLASS_COMMON(ArtifactInstanceID, si32)
  247. friend class CGameInfoCallback;
  248. friend class CNonConstInfoCallback;
  249. };
  250. class QueryID : public BaseForID<QueryID, si32>
  251. {
  252. INSTID_LIKE_CLASS_COMMON(QueryID, si32)
  253. QueryID & operator++()
  254. {
  255. ++num;
  256. return *this;
  257. }
  258. };
  259. class ObjectInstanceID : public BaseForID<ObjectInstanceID, si32>
  260. {
  261. INSTID_LIKE_CLASS_COMMON(ObjectInstanceID, si32)
  262. friend class CGameInfoCallback;
  263. friend class CNonConstInfoCallback;
  264. };
  265. class HeroClassID : public BaseForID<HeroClassID, si32>
  266. {
  267. INSTID_LIKE_CLASS_COMMON(HeroClassID, si32)
  268. };
  269. class HeroTypeID : public BaseForID<HeroTypeID, si32>
  270. {
  271. INSTID_LIKE_CLASS_COMMON(HeroTypeID, si32)
  272. ///json serialization helpers
  273. static si32 decode(const std::string & identifier);
  274. static std::string encode(const si32 index);
  275. };
  276. class SlotID : public BaseForID<SlotID, si32>
  277. {
  278. INSTID_LIKE_CLASS_COMMON(SlotID, si32)
  279. friend class CGameInfoCallback;
  280. friend class CNonConstInfoCallback;
  281. DLL_LINKAGE static const SlotID COMMANDER_SLOT_PLACEHOLDER;
  282. DLL_LINKAGE static const SlotID SUMMONED_SLOT_PLACEHOLDER; ///<for all summoned creatures, only during battle
  283. DLL_LINKAGE static const SlotID WAR_MACHINES_SLOT; ///<for all war machines during battle
  284. DLL_LINKAGE static const SlotID ARROW_TOWERS_SLOT; ///<for all arrow towers during battle
  285. bool validSlot() const
  286. {
  287. return getNum() >= 0 && getNum() < GameConstants::ARMY_SIZE;
  288. }
  289. };
  290. class PlayerColor : public BaseForID<PlayerColor, ui8>
  291. {
  292. INSTID_LIKE_CLASS_COMMON(PlayerColor, ui8)
  293. enum EPlayerColor
  294. {
  295. PLAYER_LIMIT_I = 8
  296. };
  297. DLL_LINKAGE static const PlayerColor SPECTATOR; //252
  298. DLL_LINKAGE static const PlayerColor CANNOT_DETERMINE; //253
  299. DLL_LINKAGE static const PlayerColor UNFLAGGABLE; //254 - neutral objects (pandora, banks)
  300. DLL_LINKAGE static const PlayerColor NEUTRAL; //255
  301. DLL_LINKAGE static const PlayerColor PLAYER_LIMIT; //player limit per map
  302. DLL_LINKAGE bool isValidPlayer() const; //valid means < PLAYER_LIMIT (especially non-neutral)
  303. DLL_LINKAGE bool isSpectator() const;
  304. DLL_LINKAGE std::string getStr(bool L10n = false) const;
  305. DLL_LINKAGE std::string getStrCap(bool L10n = false) const;
  306. friend class CGameInfoCallback;
  307. friend class CNonConstInfoCallback;
  308. };
  309. class TeamID : public BaseForID<TeamID, ui8>
  310. {
  311. INSTID_LIKE_CLASS_COMMON(TeamID, ui8)
  312. DLL_LINKAGE static const TeamID NO_TEAM;
  313. friend class CGameInfoCallback;
  314. friend class CNonConstInfoCallback;
  315. };
  316. class TeleportChannelID : public BaseForID<TeleportChannelID, si32>
  317. {
  318. INSTID_LIKE_CLASS_COMMON(TeleportChannelID, si32)
  319. friend class CGameInfoCallback;
  320. friend class CNonConstInfoCallback;
  321. };
  322. // #ifndef INSTANTIATE_BASE_FOR_ID_HERE
  323. // extern template std::ostream & operator << <ArtifactInstanceID>(std::ostream & os, BaseForID<ArtifactInstanceID> id);
  324. // extern template std::ostream & operator << <ObjectInstanceID>(std::ostream & os, BaseForID<ObjectInstanceID> id);
  325. // #endif
  326. // Enum declarations
  327. namespace PrimarySkill
  328. {
  329. enum PrimarySkill : int8_t { NONE = -1, ATTACK, DEFENSE, SPELL_POWER, KNOWLEDGE,
  330. EXPERIENCE = 4}; //for some reason changePrimSkill uses it
  331. }
  332. class SecondarySkill
  333. {
  334. public:
  335. enum ESecondarySkill
  336. {
  337. WRONG = -2,
  338. DEFAULT = -1,
  339. PATHFINDING = 0, ARCHERY, LOGISTICS, SCOUTING, DIPLOMACY, NAVIGATION, LEADERSHIP, WISDOM, MYSTICISM,
  340. LUCK, BALLISTICS, EAGLE_EYE, NECROMANCY, ESTATES, FIRE_MAGIC, AIR_MAGIC, WATER_MAGIC, EARTH_MAGIC,
  341. SCHOLAR, TACTICS, ARTILLERY, LEARNING, OFFENCE, ARMORER, INTELLIGENCE, SORCERY, RESISTANCE,
  342. FIRST_AID, SKILL_SIZE
  343. };
  344. static_assert(GameConstants::SKILL_QUANTITY == SKILL_SIZE, "Incorrect number of skills");
  345. SecondarySkill(ESecondarySkill _num = WRONG) : num(_num)
  346. {}
  347. ID_LIKE_CLASS_COMMON(SecondarySkill, ESecondarySkill)
  348. ESecondarySkill num;
  349. };
  350. ID_LIKE_OPERATORS(SecondarySkill, SecondarySkill::ESecondarySkill)
  351. enum class EAlignment : uint8_t { GOOD, EVIL, NEUTRAL };
  352. namespace ETownType//deprecated
  353. {
  354. enum ETownType
  355. {
  356. ANY = -1,
  357. CASTLE, RAMPART, TOWER, INFERNO, NECROPOLIS, DUNGEON, STRONGHOLD, FORTRESS, CONFLUX, NEUTRAL
  358. };
  359. }
  360. class FactionID : public BaseForID<FactionID, int32_t>
  361. {
  362. INSTID_LIKE_CLASS_COMMON(FactionID, si32)
  363. DLL_LINKAGE static const FactionID NONE;
  364. DLL_LINKAGE static const FactionID DEFAULT;
  365. DLL_LINKAGE static const FactionID CASTLE;
  366. DLL_LINKAGE static const FactionID RAMPART;
  367. DLL_LINKAGE static const FactionID TOWER;
  368. DLL_LINKAGE static const FactionID INFERNO;
  369. DLL_LINKAGE static const FactionID NECROPOLIS;
  370. DLL_LINKAGE static const FactionID DUNGEON;
  371. DLL_LINKAGE static const FactionID STRONGHOLD;
  372. DLL_LINKAGE static const FactionID FORTRESS;
  373. DLL_LINKAGE static const FactionID CONFLUX;
  374. DLL_LINKAGE static const FactionID NEUTRAL;
  375. ///json serialization helpers
  376. static si32 decode(const std::string & identifier);
  377. static std::string encode(const si32 index);
  378. };
  379. class BuildingID
  380. {
  381. public:
  382. //Quite useful as long as most of building mechanics hardcoded
  383. // NOTE: all building with completely configurable mechanics will be removed from list
  384. enum EBuildingID
  385. {
  386. DEFAULT = -50,
  387. HORDE_PLACEHOLDER7 = -36,
  388. HORDE_PLACEHOLDER6 = -35,
  389. HORDE_PLACEHOLDER5 = -34,
  390. HORDE_PLACEHOLDER4 = -33,
  391. HORDE_PLACEHOLDER3 = -32,
  392. HORDE_PLACEHOLDER2 = -31,
  393. HORDE_PLACEHOLDER1 = -30,
  394. NONE = -1,
  395. FIRST_REGULAR_ID = 0,
  396. MAGES_GUILD_1 = 0, MAGES_GUILD_2, MAGES_GUILD_3, MAGES_GUILD_4, MAGES_GUILD_5,
  397. TAVERN, SHIPYARD, FORT, CITADEL, CASTLE,
  398. VILLAGE_HALL, TOWN_HALL, CITY_HALL, CAPITOL, MARKETPLACE,
  399. RESOURCE_SILO, BLACKSMITH, SPECIAL_1, HORDE_1, HORDE_1_UPGR,
  400. SHIP, SPECIAL_2, SPECIAL_3, SPECIAL_4, HORDE_2,
  401. HORDE_2_UPGR, GRAIL, EXTRA_TOWN_HALL, EXTRA_CITY_HALL, EXTRA_CAPITOL,
  402. DWELL_FIRST=30, DWELL_LVL_2, DWELL_LVL_3, DWELL_LVL_4, DWELL_LVL_5, DWELL_LVL_6, DWELL_LAST=36,
  403. DWELL_UP_FIRST=37, DWELL_LVL_2_UP, DWELL_LVL_3_UP, DWELL_LVL_4_UP, DWELL_LVL_5_UP,
  404. DWELL_LVL_6_UP, DWELL_UP_LAST=43,
  405. DWELL_LVL_1 = DWELL_FIRST,
  406. DWELL_LVL_7 = DWELL_LAST,
  407. DWELL_LVL_1_UP = DWELL_UP_FIRST,
  408. DWELL_LVL_7_UP = DWELL_UP_LAST,
  409. //Special buildings for towns.
  410. LIGHTHOUSE = SPECIAL_1,
  411. STABLES = SPECIAL_2, //Castle
  412. BROTHERHOOD = SPECIAL_3,
  413. MYSTIC_POND = SPECIAL_1,
  414. FOUNTAIN_OF_FORTUNE = SPECIAL_2, //Rampart
  415. TREASURY = SPECIAL_3,
  416. ARTIFACT_MERCHANT = SPECIAL_1,
  417. LOOKOUT_TOWER = SPECIAL_2, //Tower
  418. LIBRARY = SPECIAL_3,
  419. WALL_OF_KNOWLEDGE = SPECIAL_4,
  420. STORMCLOUDS = SPECIAL_2,
  421. CASTLE_GATE = SPECIAL_3, //Inferno
  422. ORDER_OF_FIRE = SPECIAL_4,
  423. COVER_OF_DARKNESS = SPECIAL_1,
  424. NECROMANCY_AMPLIFIER = SPECIAL_2, //Necropolis
  425. SKELETON_TRANSFORMER = SPECIAL_3,
  426. //ARTIFACT_MERCHANT - same ID as in tower
  427. MANA_VORTEX = SPECIAL_2,
  428. PORTAL_OF_SUMMON = SPECIAL_3, //Dungeon
  429. BATTLE_ACADEMY = SPECIAL_4,
  430. ESCAPE_TUNNEL = SPECIAL_1,
  431. FREELANCERS_GUILD = SPECIAL_2, //Stronghold
  432. BALLISTA_YARD = SPECIAL_3,
  433. HALL_OF_VALHALLA = SPECIAL_4,
  434. CAGE_OF_WARLORDS = SPECIAL_1,
  435. GLYPHS_OF_FEAR = SPECIAL_2, // Fortress
  436. BLOOD_OBELISK = SPECIAL_3,
  437. //ARTIFACT_MERCHANT - same ID as in tower
  438. MAGIC_UNIVERSITY = SPECIAL_2, // Conflux
  439. };
  440. BuildingID(EBuildingID _num = NONE) : num(_num)
  441. {}
  442. STRONG_INLINE
  443. bool IsSpecialOrGrail() const
  444. {
  445. return num == SPECIAL_1 || num == SPECIAL_2 || num == SPECIAL_3 || num == SPECIAL_4 || num == GRAIL;
  446. }
  447. ID_LIKE_CLASS_COMMON(BuildingID, EBuildingID)
  448. EBuildingID num;
  449. };
  450. ID_LIKE_OPERATORS(BuildingID, BuildingID::EBuildingID)
  451. namespace BuildingSubID
  452. {
  453. enum EBuildingSubID
  454. {
  455. DEFAULT = -50,
  456. NONE = -1,
  457. STABLES,
  458. BROTHERHOOD_OF_SWORD,
  459. CASTLE_GATE,
  460. CREATURE_TRANSFORMER,
  461. MYSTIC_POND,
  462. FOUNTAIN_OF_FORTUNE,
  463. ARTIFACT_MERCHANT,
  464. LOOKOUT_TOWER,
  465. LIBRARY,
  466. MANA_VORTEX,
  467. PORTAL_OF_SUMMONING,
  468. ESCAPE_TUNNEL,
  469. FREELANCERS_GUILD,
  470. BALLISTA_YARD,
  471. ATTACK_VISITING_BONUS,
  472. MAGIC_UNIVERSITY,
  473. SPELL_POWER_GARRISON_BONUS,
  474. ATTACK_GARRISON_BONUS,
  475. DEFENSE_GARRISON_BONUS,
  476. DEFENSE_VISITING_BONUS,
  477. SPELL_POWER_VISITING_BONUS,
  478. KNOWLEDGE_VISITING_BONUS,
  479. EXPERIENCE_VISITING_BONUS,
  480. LIGHTHOUSE,
  481. TREASURY,
  482. CUSTOM_VISITING_BONUS,
  483. CUSTOM_VISITING_REWARD
  484. };
  485. }
  486. namespace EMarketMode
  487. {
  488. enum EMarketMode
  489. {
  490. RESOURCE_RESOURCE, RESOURCE_PLAYER, CREATURE_RESOURCE, RESOURCE_ARTIFACT,
  491. ARTIFACT_RESOURCE, ARTIFACT_EXP, CREATURE_EXP, CREATURE_UNDEAD, RESOURCE_SKILL,
  492. MARTKET_AFTER_LAST_PLACEHOLDER
  493. };
  494. }
  495. namespace MappedKeys
  496. {
  497. static const std::map<std::string, BuildingID> BUILDING_NAMES_TO_TYPES =
  498. {
  499. { "special1", BuildingID::SPECIAL_1 },
  500. { "special2", BuildingID::SPECIAL_2 },
  501. { "special3", BuildingID::SPECIAL_3 },
  502. { "special4", BuildingID::SPECIAL_4 },
  503. { "grail", BuildingID::GRAIL },
  504. { "mageGuild1", BuildingID::MAGES_GUILD_1 },
  505. { "mageGuild2", BuildingID::MAGES_GUILD_2 },
  506. { "mageGuild3", BuildingID::MAGES_GUILD_3 },
  507. { "mageGuild4", BuildingID::MAGES_GUILD_4 },
  508. { "mageGuild5", BuildingID::MAGES_GUILD_5 },
  509. { "tavern", BuildingID::TAVERN },
  510. { "shipyard", BuildingID::SHIPYARD },
  511. { "fort", BuildingID::FORT },
  512. { "citadel", BuildingID::CITADEL },
  513. { "castle", BuildingID::CASTLE },
  514. { "villageHall", BuildingID::VILLAGE_HALL },
  515. { "townHall", BuildingID::TOWN_HALL },
  516. { "cityHall", BuildingID::CITY_HALL },
  517. { "capitol", BuildingID::CAPITOL },
  518. { "marketplace", BuildingID::MARKETPLACE },
  519. { "resourceSilo", BuildingID::RESOURCE_SILO },
  520. { "blacksmith", BuildingID::BLACKSMITH },
  521. { "horde1", BuildingID::HORDE_1 },
  522. { "horde1Upgr", BuildingID::HORDE_1_UPGR },
  523. { "horde2", BuildingID::HORDE_2 },
  524. { "horde2Upgr", BuildingID::HORDE_2_UPGR },
  525. { "ship", BuildingID::SHIP },
  526. { "dwellingLvl1", BuildingID::DWELL_LVL_1 },
  527. { "dwellingLvl2", BuildingID::DWELL_LVL_2 },
  528. { "dwellingLvl3", BuildingID::DWELL_LVL_3 },
  529. { "dwellingLvl4", BuildingID::DWELL_LVL_4 },
  530. { "dwellingLvl5", BuildingID::DWELL_LVL_5 },
  531. { "dwellingLvl6", BuildingID::DWELL_LVL_6 },
  532. { "dwellingLvl7", BuildingID::DWELL_LVL_7 },
  533. { "dwellingUpLvl1", BuildingID::DWELL_LVL_1_UP },
  534. { "dwellingUpLvl2", BuildingID::DWELL_LVL_2_UP },
  535. { "dwellingUpLvl3", BuildingID::DWELL_LVL_3_UP },
  536. { "dwellingUpLvl4", BuildingID::DWELL_LVL_4_UP },
  537. { "dwellingUpLvl5", BuildingID::DWELL_LVL_5_UP },
  538. { "dwellingUpLvl6", BuildingID::DWELL_LVL_6_UP },
  539. { "dwellingUpLvl7", BuildingID::DWELL_LVL_7_UP },
  540. };
  541. static const std::map<std::string, BuildingSubID::EBuildingSubID> SPECIAL_BUILDINGS =
  542. {
  543. { "mysticPond", BuildingSubID::MYSTIC_POND },
  544. { "artifactMerchant", BuildingSubID::ARTIFACT_MERCHANT },
  545. { "freelancersGuild", BuildingSubID::FREELANCERS_GUILD },
  546. { "magicUniversity", BuildingSubID::MAGIC_UNIVERSITY },
  547. { "castleGate", BuildingSubID::CASTLE_GATE },
  548. { "creatureTransformer", BuildingSubID::CREATURE_TRANSFORMER },//only skeleton transformer yet
  549. { "portalOfSummoning", BuildingSubID::PORTAL_OF_SUMMONING },
  550. { "ballistaYard", BuildingSubID::BALLISTA_YARD },
  551. { "stables", BuildingSubID::STABLES },
  552. { "manaVortex", BuildingSubID::MANA_VORTEX },
  553. { "lookoutTower", BuildingSubID::LOOKOUT_TOWER },
  554. { "library", BuildingSubID::LIBRARY },
  555. { "brotherhoodOfSword", BuildingSubID::BROTHERHOOD_OF_SWORD },//morale garrison bonus
  556. { "fountainOfFortune", BuildingSubID::FOUNTAIN_OF_FORTUNE },//luck garrison bonus
  557. { "spellPowerGarrisonBonus", BuildingSubID::SPELL_POWER_GARRISON_BONUS },//such as 'stormclouds', but this name is not ok for good towns
  558. { "attackGarrisonBonus", BuildingSubID::ATTACK_GARRISON_BONUS },
  559. { "defenseGarrisonBonus", BuildingSubID::DEFENSE_GARRISON_BONUS },
  560. { "escapeTunnel", BuildingSubID::ESCAPE_TUNNEL },
  561. { "attackVisitingBonus", BuildingSubID::ATTACK_VISITING_BONUS },
  562. { "defenceVisitingBonus", BuildingSubID::DEFENSE_VISITING_BONUS },
  563. { "spellPowerVisitingBonus", BuildingSubID::SPELL_POWER_VISITING_BONUS },
  564. { "knowledgeVisitingBonus", BuildingSubID::KNOWLEDGE_VISITING_BONUS },
  565. { "experienceVisitingBonus", BuildingSubID::EXPERIENCE_VISITING_BONUS },
  566. { "lighthouse", BuildingSubID::LIGHTHOUSE },
  567. { "treasury", BuildingSubID::TREASURY }
  568. };
  569. static const std::map<std::string, EMarketMode::EMarketMode> MARKET_NAMES_TO_TYPES =
  570. {
  571. { "resource-resource", EMarketMode::RESOURCE_RESOURCE },
  572. { "resource-player", EMarketMode::RESOURCE_PLAYER },
  573. { "creature-resource", EMarketMode::CREATURE_RESOURCE },
  574. { "resource-artifact", EMarketMode::RESOURCE_ARTIFACT },
  575. { "artifact-resource", EMarketMode::ARTIFACT_RESOURCE },
  576. { "artifact-experience", EMarketMode::ARTIFACT_EXP },
  577. { "creature-experience", EMarketMode::CREATURE_EXP },
  578. { "creature-undead", EMarketMode::CREATURE_UNDEAD },
  579. { "resource-skill", EMarketMode::RESOURCE_SKILL },
  580. };
  581. }
  582. namespace EAiTactic
  583. {
  584. enum EAiTactic
  585. {
  586. NONE = -1,
  587. RANDOM,
  588. WARRIOR,
  589. BUILDER,
  590. EXPLORER
  591. };
  592. }
  593. namespace EBuildingState
  594. {
  595. enum EBuildingState
  596. {
  597. HAVE_CAPITAL, NO_WATER, FORBIDDEN, ADD_MAGES_GUILD, ALREADY_PRESENT, CANT_BUILD_TODAY,
  598. NO_RESOURCES, ALLOWED, PREREQUIRES, MISSING_BASE, BUILDING_ERROR, TOWN_NOT_OWNED
  599. };
  600. }
  601. namespace ESpellCastProblem
  602. {
  603. enum ESpellCastProblem
  604. {
  605. OK, NO_HERO_TO_CAST_SPELL, CASTS_PER_TURN_LIMIT, NO_SPELLBOOK,
  606. HERO_DOESNT_KNOW_SPELL, NOT_ENOUGH_MANA, ADVMAP_SPELL_INSTEAD_OF_BATTLE_SPELL,
  607. SPELL_LEVEL_LIMIT_EXCEEDED, NO_SPELLS_TO_DISPEL,
  608. NO_APPROPRIATE_TARGET, STACK_IMMUNE_TO_SPELL, WRONG_SPELL_TARGET, ONGOING_TACTIC_PHASE,
  609. MAGIC_IS_BLOCKED, //For Orb of Inhibition and similar - no casting at all
  610. INVALID
  611. };
  612. }
  613. namespace ECommander
  614. {
  615. enum SecondarySkills {ATTACK, DEFENSE, HEALTH, DAMAGE, SPEED, SPELL_POWER, CASTS, RESISTANCE};
  616. const int MAX_SKILL_LEVEL = 5;
  617. }
  618. enum class EWallPart : int8_t
  619. {
  620. INDESTRUCTIBLE_PART_OF_GATE = -3, INDESTRUCTIBLE_PART = -2, INVALID = -1,
  621. KEEP = 0, BOTTOM_TOWER, BOTTOM_WALL, BELOW_GATE, OVER_GATE, UPPER_WALL, UPPER_TOWER, GATE,
  622. PARTS_COUNT /* This constant SHOULD always stay as the last item in the enum. */
  623. };
  624. enum class EWallState : int8_t
  625. {
  626. NONE = -1, //no wall
  627. DESTROYED,
  628. DAMAGED,
  629. INTACT,
  630. REINFORCED, // walls in towns with castle
  631. };
  632. enum class EGateState : uint8_t
  633. {
  634. NONE,
  635. CLOSED,
  636. BLOCKED, // gate is blocked in closed state, e.g. by creature
  637. OPENED,
  638. DESTROYED
  639. };
  640. namespace ESiegeHex
  641. {
  642. enum ESiegeHex : si16
  643. {
  644. DESTRUCTIBLE_WALL_1 = 29,
  645. DESTRUCTIBLE_WALL_2 = 78,
  646. DESTRUCTIBLE_WALL_3 = 130,
  647. DESTRUCTIBLE_WALL_4 = 182,
  648. GATE_BRIDGE = 94,
  649. GATE_OUTER = 95,
  650. GATE_INNER = 96
  651. };
  652. }
  653. namespace ETileType
  654. {
  655. enum ETileType
  656. {
  657. FREE,
  658. POSSIBLE,
  659. BLOCKED,
  660. USED
  661. };
  662. }
  663. enum class ETeleportChannelType
  664. {
  665. IMPASSABLE,
  666. BIDIRECTIONAL,
  667. UNIDIRECTIONAL,
  668. MIXED
  669. };
  670. class Obj
  671. {
  672. public:
  673. enum EObj
  674. {
  675. NO_OBJ = -1,
  676. ALTAR_OF_SACRIFICE [[deprecated]] = 2,
  677. ANCHOR_POINT = 3,
  678. ARENA = 4,
  679. ARTIFACT = 5,
  680. PANDORAS_BOX = 6,
  681. BLACK_MARKET [[deprecated]] = 7,
  682. BOAT = 8,
  683. BORDERGUARD = 9,
  684. KEYMASTER = 10,
  685. BUOY = 11,
  686. CAMPFIRE = 12,
  687. CARTOGRAPHER = 13,
  688. SWAN_POND = 14,
  689. COVER_OF_DARKNESS = 15,
  690. CREATURE_BANK = 16,
  691. CREATURE_GENERATOR1 = 17,
  692. CREATURE_GENERATOR2 = 18,
  693. CREATURE_GENERATOR3 = 19,
  694. CREATURE_GENERATOR4 = 20,
  695. CURSED_GROUND1 = 21,
  696. CORPSE = 22,
  697. MARLETTO_TOWER = 23,
  698. DERELICT_SHIP = 24,
  699. DRAGON_UTOPIA = 25,
  700. EVENT = 26,
  701. EYE_OF_MAGI = 27,
  702. FAERIE_RING = 28,
  703. FLOTSAM = 29,
  704. FOUNTAIN_OF_FORTUNE = 30,
  705. FOUNTAIN_OF_YOUTH = 31,
  706. GARDEN_OF_REVELATION = 32,
  707. GARRISON = 33,
  708. HERO = 34,
  709. HILL_FORT = 35,
  710. GRAIL = 36,
  711. HUT_OF_MAGI = 37,
  712. IDOL_OF_FORTUNE = 38,
  713. LEAN_TO = 39,
  714. LIBRARY_OF_ENLIGHTENMENT = 41,
  715. LIGHTHOUSE = 42,
  716. MONOLITH_ONE_WAY_ENTRANCE = 43,
  717. MONOLITH_ONE_WAY_EXIT = 44,
  718. MONOLITH_TWO_WAY = 45,
  719. MAGIC_PLAINS1 = 46,
  720. SCHOOL_OF_MAGIC = 47,
  721. MAGIC_SPRING = 48,
  722. MAGIC_WELL = 49,
  723. MARKET_OF_TIME = 50,
  724. MERCENARY_CAMP = 51,
  725. MERMAID = 52,
  726. MINE = 53,
  727. MONSTER = 54,
  728. MYSTICAL_GARDEN = 55,
  729. OASIS = 56,
  730. OBELISK = 57,
  731. REDWOOD_OBSERVATORY = 58,
  732. OCEAN_BOTTLE = 59,
  733. PILLAR_OF_FIRE = 60,
  734. STAR_AXIS = 61,
  735. PRISON = 62,
  736. PYRAMID = 63,//subtype 0
  737. WOG_OBJECT = 63,//subtype > 0
  738. RALLY_FLAG = 64,
  739. RANDOM_ART = 65,
  740. RANDOM_TREASURE_ART = 66,
  741. RANDOM_MINOR_ART = 67,
  742. RANDOM_MAJOR_ART = 68,
  743. RANDOM_RELIC_ART = 69,
  744. RANDOM_HERO = 70,
  745. RANDOM_MONSTER = 71,
  746. RANDOM_MONSTER_L1 = 72,
  747. RANDOM_MONSTER_L2 = 73,
  748. RANDOM_MONSTER_L3 = 74,
  749. RANDOM_MONSTER_L4 = 75,
  750. RANDOM_RESOURCE = 76,
  751. RANDOM_TOWN = 77,
  752. REFUGEE_CAMP = 78,
  753. RESOURCE = 79,
  754. SANCTUARY = 80,
  755. SCHOLAR = 81,
  756. SEA_CHEST = 82,
  757. SEER_HUT = 83,
  758. CRYPT = 84,
  759. SHIPWRECK = 85,
  760. SHIPWRECK_SURVIVOR = 86,
  761. SHIPYARD = 87,
  762. SHRINE_OF_MAGIC_INCANTATION = 88,
  763. SHRINE_OF_MAGIC_GESTURE = 89,
  764. SHRINE_OF_MAGIC_THOUGHT = 90,
  765. SIGN = 91,
  766. SIRENS = 92,
  767. SPELL_SCROLL = 93,
  768. STABLES = 94,
  769. TAVERN = 95,
  770. TEMPLE = 96,
  771. DEN_OF_THIEVES = 97,
  772. TOWN = 98,
  773. TRADING_POST [[deprecated]] = 99,
  774. LEARNING_STONE = 100,
  775. TREASURE_CHEST = 101,
  776. TREE_OF_KNOWLEDGE = 102,
  777. SUBTERRANEAN_GATE = 103,
  778. UNIVERSITY [[deprecated]] = 104,
  779. WAGON = 105,
  780. WAR_MACHINE_FACTORY = 106,
  781. SCHOOL_OF_WAR = 107,
  782. WARRIORS_TOMB = 108,
  783. WATER_WHEEL = 109,
  784. WATERING_HOLE = 110,
  785. WHIRLPOOL = 111,
  786. WINDMILL = 112,
  787. WITCH_HUT = 113,
  788. HOLE = 124,
  789. RANDOM_MONSTER_L5 = 162,
  790. RANDOM_MONSTER_L6 = 163,
  791. RANDOM_MONSTER_L7 = 164,
  792. BORDER_GATE = 212,
  793. FREELANCERS_GUILD [[deprecated]] = 213,
  794. HERO_PLACEHOLDER = 214,
  795. QUEST_GUARD = 215,
  796. RANDOM_DWELLING = 216,
  797. RANDOM_DWELLING_LVL = 217, //subtype = creature level
  798. RANDOM_DWELLING_FACTION = 218, //subtype = faction
  799. GARRISON2 = 219,
  800. ABANDONED_MINE = 220,
  801. TRADING_POST_SNOW [[deprecated]] = 221,
  802. CLOVER_FIELD = 222,
  803. CURSED_GROUND2 = 223,
  804. EVIL_FOG = 224,
  805. FAVORABLE_WINDS = 225,
  806. FIERY_FIELDS = 226,
  807. HOLY_GROUNDS = 227,
  808. LUCID_POOLS = 228,
  809. MAGIC_CLOUDS = 229,
  810. MAGIC_PLAINS2 = 230,
  811. ROCKLANDS = 231,
  812. };
  813. Obj(EObj _num = NO_OBJ) : num(_num)
  814. {}
  815. ID_LIKE_CLASS_COMMON(Obj, EObj)
  816. EObj num;
  817. };
  818. ID_LIKE_OPERATORS(Obj, Obj::EObj)
  819. enum class Road : int8_t
  820. {
  821. NO_ROAD = 0,
  822. FIRST_REGULAR_ROAD = 1,
  823. DIRT_ROAD = 1,
  824. GRAVEL_ROAD = 2,
  825. COBBLESTONE_ROAD = 3,
  826. ORIGINAL_ROAD_COUNT //+1
  827. };
  828. enum class River : int8_t
  829. {
  830. NO_RIVER = 0,
  831. FIRST_REGULAR_RIVER = 1,
  832. WATER_RIVER = 1,
  833. ICY_RIVER = 2,
  834. MUD_RIVER = 3,
  835. LAVA_RIVER = 4,
  836. ORIGINAL_RIVER_COUNT //+1
  837. };
  838. namespace SecSkillLevel
  839. {
  840. enum SecSkillLevel
  841. {
  842. NONE,
  843. BASIC,
  844. ADVANCED,
  845. EXPERT,
  846. LEVELS_SIZE
  847. };
  848. }
  849. namespace Date
  850. {
  851. enum EDateType
  852. {
  853. DAY = 0,
  854. DAY_OF_WEEK = 1,
  855. WEEK = 2,
  856. MONTH = 3,
  857. DAY_OF_MONTH
  858. };
  859. }
  860. enum class EActionType : int32_t
  861. {
  862. CANCEL = -3,
  863. END_TACTIC_PHASE = -2,
  864. INVALID = -1,
  865. NO_ACTION = 0,
  866. HERO_SPELL,
  867. WALK,
  868. DEFEND,
  869. RETREAT,
  870. SURRENDER,
  871. WALK_AND_ATTACK,
  872. SHOOT,
  873. WAIT,
  874. CATAPULT,
  875. MONSTER_SPELL,
  876. BAD_MORALE,
  877. STACK_HEAL,
  878. };
  879. DLL_LINKAGE std::ostream & operator<<(std::ostream & os, const EActionType actionType);
  880. class DLL_LINKAGE EDiggingStatus
  881. {
  882. public:
  883. enum EEDiggingStatus
  884. {
  885. UNKNOWN = -1,
  886. CAN_DIG = 0,
  887. LACK_OF_MOVEMENT,
  888. WRONG_TERRAIN,
  889. TILE_OCCUPIED,
  890. BACKPACK_IS_FULL
  891. };
  892. EDiggingStatus(EEDiggingStatus _num = UNKNOWN) : num(_num)
  893. {}
  894. ID_LIKE_CLASS_COMMON(EDiggingStatus, EEDiggingStatus)
  895. EEDiggingStatus num;
  896. };
  897. ID_LIKE_OPERATORS(EDiggingStatus, EDiggingStatus::EEDiggingStatus)
  898. class DLL_LINKAGE EPathfindingLayer
  899. {
  900. public:
  901. enum EEPathfindingLayer : ui8
  902. {
  903. LAND = 0, SAIL = 1, WATER, AIR, NUM_LAYERS, WRONG, AUTO
  904. };
  905. EPathfindingLayer(EEPathfindingLayer _num = WRONG) : num(_num)
  906. {}
  907. ID_LIKE_CLASS_COMMON(EPathfindingLayer, EEPathfindingLayer)
  908. EEPathfindingLayer num;
  909. };
  910. DLL_LINKAGE std::ostream & operator<<(std::ostream & os, const EPathfindingLayer & pathfindingLayer);
  911. ID_LIKE_OPERATORS(EPathfindingLayer, EPathfindingLayer::EEPathfindingLayer)
  912. namespace EPlayerStatus
  913. {
  914. enum EStatus {WRONG = -1, INGAME, LOSER, WINNER};
  915. }
  916. namespace PlayerRelations
  917. {
  918. enum PlayerRelations {ENEMIES, ALLIES, SAME_PLAYER};
  919. }
  920. class ArtifactPosition
  921. {
  922. public:
  923. enum EArtifactPosition
  924. {
  925. TRANSITION_POS = -3,
  926. FIRST_AVAILABLE = -2,
  927. PRE_FIRST = -1, //sometimes used as error, sometimes as first free in backpack
  928. HEAD, SHOULDERS, NECK, RIGHT_HAND, LEFT_HAND, TORSO, //5
  929. RIGHT_RING, LEFT_RING, FEET, //8
  930. MISC1, MISC2, MISC3, MISC4, //12
  931. MACH1, MACH2, MACH3, MACH4, //16
  932. SPELLBOOK, MISC5, //18
  933. AFTER_LAST,
  934. //cres
  935. CREATURE_SLOT = 0,
  936. COMMANDER1 = 0, COMMANDER2, COMMANDER3, COMMANDER4, COMMANDER5, COMMANDER6, COMMANDER_AFTER_LAST
  937. };
  938. static_assert (AFTER_LAST == 19, "incorrect number of artifact slots");
  939. ArtifactPosition(EArtifactPosition _num = PRE_FIRST) : num(_num)
  940. {}
  941. ArtifactPosition(std::string slotName);
  942. ID_LIKE_CLASS_COMMON(ArtifactPosition, EArtifactPosition)
  943. EArtifactPosition num;
  944. STRONG_INLINE EArtifactPosition operator+(const int arg)
  945. {
  946. return EArtifactPosition(static_cast<int>(num) + arg);
  947. }
  948. STRONG_INLINE EArtifactPosition operator+(const EArtifactPosition & arg)
  949. {
  950. return EArtifactPosition(static_cast<int>(num) + static_cast<int>(arg));
  951. }
  952. };
  953. ID_LIKE_OPERATORS(ArtifactPosition, ArtifactPosition::EArtifactPosition)
  954. namespace GameConstants
  955. {
  956. const auto BACKPACK_START = ArtifactPosition::AFTER_LAST;
  957. }
  958. class ArtifactID
  959. {
  960. public:
  961. enum EArtifactID
  962. {
  963. NONE = -1,
  964. SPELLBOOK = 0,
  965. SPELL_SCROLL = 1,
  966. GRAIL = 2,
  967. CATAPULT = 3,
  968. BALLISTA = 4,
  969. AMMO_CART = 5,
  970. FIRST_AID_TENT = 6,
  971. //CENTAUR_AXE = 7,
  972. //BLACKSHARD_OF_THE_DEAD_KNIGHT = 8,
  973. VIAL_OF_DRAGON_BLOOD = 127,
  974. ARMAGEDDONS_BLADE = 128,
  975. TITANS_THUNDER = 135,
  976. //CORNUCOPIA = 140,
  977. //FIXME: the following is only true if WoG is enabled. Otherwise other mod artifacts will take these slots.
  978. ART_SELECTION = 144,
  979. ART_LOCK = 145, // FIXME: We must get rid of this one since it's conflict with artifact from mods. See issue 2455
  980. AXE_OF_SMASHING = 146,
  981. MITHRIL_MAIL = 147,
  982. SWORD_OF_SHARPNESS = 148,
  983. HELM_OF_IMMORTALITY = 149,
  984. PENDANT_OF_SORCERY = 150,
  985. BOOTS_OF_HASTE = 151,
  986. BOW_OF_SEEKING = 152,
  987. DRAGON_EYE_RING = 153
  988. //HARDENED_SHIELD = 154,
  989. //SLAVAS_RING_OF_POWER = 155
  990. };
  991. ArtifactID(EArtifactID _num = NONE) : num(_num)
  992. {}
  993. DLL_LINKAGE const CArtifact * toArtifact() const;
  994. DLL_LINKAGE const Artifact * toArtifact(const ArtifactService * service) const;
  995. ///json serialization helpers
  996. static si32 decode(const std::string & identifier);
  997. static std::string encode(const si32 index);
  998. ID_LIKE_CLASS_COMMON(ArtifactID, EArtifactID)
  999. EArtifactID num;
  1000. struct hash
  1001. {
  1002. size_t operator()(const ArtifactID & aid) const
  1003. {
  1004. return std::hash<int>()(aid.num);
  1005. }
  1006. };
  1007. };
  1008. ID_LIKE_OPERATORS(ArtifactID, ArtifactID::EArtifactID)
  1009. class CreatureID
  1010. {
  1011. public:
  1012. enum ECreatureID
  1013. {
  1014. NONE = -1,
  1015. ARCHER = 2,
  1016. CAVALIER = 10,
  1017. CHAMPION = 11,
  1018. STONE_GOLEM = 32,
  1019. IRON_GOLEM = 33,
  1020. IMP = 42,
  1021. SKELETON = 56,
  1022. WALKING_DEAD = 58,
  1023. WIGHTS = 60,
  1024. LICHES = 64,
  1025. BONE_DRAGON = 68,
  1026. TROGLODYTES = 70,
  1027. MEDUSA = 76,
  1028. HYDRA = 110,
  1029. CHAOS_HYDRA = 111,
  1030. AIR_ELEMENTAL = 112,
  1031. EARTH_ELEMENTAL = 113,
  1032. FIRE_ELEMENTAL = 114,
  1033. WATER_ELEMENTAL = 115,
  1034. GOLD_GOLEM = 116,
  1035. DIAMOND_GOLEM = 117,
  1036. PSYCHIC_ELEMENTAL = 120,
  1037. MAGIC_ELEMENTAL = 121,
  1038. CATAPULT = 145,
  1039. BALLISTA = 146,
  1040. FIRST_AID_TENT = 147,
  1041. AMMO_CART = 148,
  1042. ARROW_TOWERS = 149
  1043. };
  1044. CreatureID(ECreatureID _num = NONE) : num(_num)
  1045. {}
  1046. DLL_LINKAGE const CCreature * toCreature() const;
  1047. DLL_LINKAGE const Creature * toCreature(const CreatureService * creatures) const;
  1048. ID_LIKE_CLASS_COMMON(CreatureID, ECreatureID)
  1049. ECreatureID num;
  1050. ///json serialization helpers
  1051. static si32 decode(const std::string & identifier);
  1052. static std::string encode(const si32 index);
  1053. };
  1054. ID_LIKE_OPERATORS(CreatureID, CreatureID::ECreatureID)
  1055. class SpellID
  1056. {
  1057. public:
  1058. enum ESpellID
  1059. {
  1060. PRESET = -2,
  1061. NONE = -1,
  1062. SUMMON_BOAT=0, SCUTTLE_BOAT=1, VISIONS=2, VIEW_EARTH=3, DISGUISE=4, VIEW_AIR=5,
  1063. FLY=6, WATER_WALK=7, DIMENSION_DOOR=8, TOWN_PORTAL=9,
  1064. QUICKSAND=10, LAND_MINE=11, FORCE_FIELD=12, FIRE_WALL=13, EARTHQUAKE=14,
  1065. MAGIC_ARROW=15, ICE_BOLT=16, LIGHTNING_BOLT=17, IMPLOSION=18,
  1066. CHAIN_LIGHTNING=19, FROST_RING=20, FIREBALL=21, INFERNO=22,
  1067. METEOR_SHOWER=23, DEATH_RIPPLE=24, DESTROY_UNDEAD=25, ARMAGEDDON=26,
  1068. SHIELD=27, AIR_SHIELD=28, FIRE_SHIELD=29, PROTECTION_FROM_AIR=30,
  1069. PROTECTION_FROM_FIRE=31, PROTECTION_FROM_WATER=32,
  1070. PROTECTION_FROM_EARTH=33, ANTI_MAGIC=34, DISPEL=35, MAGIC_MIRROR=36,
  1071. CURE=37, RESURRECTION=38, ANIMATE_DEAD=39, SACRIFICE=40, BLESS=41,
  1072. CURSE=42, BLOODLUST=43, PRECISION=44, WEAKNESS=45, STONE_SKIN=46,
  1073. DISRUPTING_RAY=47, PRAYER=48, MIRTH=49, SORROW=50, FORTUNE=51,
  1074. MISFORTUNE=52, HASTE=53, SLOW=54, SLAYER=55, FRENZY=56,
  1075. TITANS_LIGHTNING_BOLT=57, COUNTERSTRIKE=58, BERSERK=59, HYPNOTIZE=60,
  1076. FORGETFULNESS=61, BLIND=62, TELEPORT=63, REMOVE_OBSTACLE=64, CLONE=65,
  1077. SUMMON_FIRE_ELEMENTAL=66, SUMMON_EARTH_ELEMENTAL=67, SUMMON_WATER_ELEMENTAL=68, SUMMON_AIR_ELEMENTAL=69,
  1078. STONE_GAZE=70, POISON=71, BIND=72, DISEASE=73, PARALYZE=74, AGE=75, DEATH_CLOUD=76, THUNDERBOLT=77,
  1079. DISPEL_HELPFUL_SPELLS=78, DEATH_STARE=79, ACID_BREATH_DEFENSE=80, ACID_BREATH_DAMAGE=81,
  1080. FIRST_NON_SPELL = 70, AFTER_LAST = 82
  1081. };
  1082. SpellID(ESpellID _num = NONE) : num(_num)
  1083. {}
  1084. DLL_LINKAGE const CSpell * toSpell() const; //deprecated
  1085. DLL_LINKAGE const spells::Spell * toSpell(const spells::Service * service) const;
  1086. ID_LIKE_CLASS_COMMON(SpellID, ESpellID)
  1087. ESpellID num;
  1088. ///json serialization helpers
  1089. static si32 decode(const std::string & identifier);
  1090. static std::string encode(const si32 index);
  1091. };
  1092. ID_LIKE_OPERATORS(SpellID, SpellID::ESpellID)
  1093. class BattleFieldInfo;
  1094. class BattleField : public BaseForID<BattleField, si32>
  1095. {
  1096. INSTID_LIKE_CLASS_COMMON(BattleField, si32)
  1097. DLL_LINKAGE static const BattleField NONE;
  1098. DLL_LINKAGE friend bool operator==(const BattleField & l, const BattleField & r);
  1099. DLL_LINKAGE friend bool operator!=(const BattleField & l, const BattleField & r);
  1100. DLL_LINKAGE friend bool operator<(const BattleField & l, const BattleField & r);
  1101. DLL_LINKAGE operator std::string() const;
  1102. DLL_LINKAGE const BattleFieldInfo * getInfo() const;
  1103. DLL_LINKAGE static BattleField fromString(const std::string & identifier);
  1104. };
  1105. enum class EBoatId : int32_t
  1106. {
  1107. NONE = -1,
  1108. NECROPOLIS = 0,
  1109. CASTLE,
  1110. FORTRESS
  1111. };
  1112. using BoatId = Identifier<EBoatId>;
  1113. enum class ETerrainId {
  1114. NATIVE_TERRAIN = -4,
  1115. ANY_TERRAIN = -3,
  1116. NONE = -1,
  1117. FIRST_REGULAR_TERRAIN = 0,
  1118. DIRT = 0,
  1119. SAND,
  1120. GRASS,
  1121. SNOW,
  1122. SWAMP,
  1123. ROUGH,
  1124. SUBTERRANEAN,
  1125. LAVA,
  1126. WATER,
  1127. ROCK,
  1128. ORIGINAL_REGULAR_TERRAIN_COUNT = ROCK
  1129. };
  1130. using TerrainId = Identifier<ETerrainId>;
  1131. using RoadId = Identifier<Road>;
  1132. using RiverId = Identifier<River>;
  1133. class ObstacleInfo;
  1134. class Obstacle : public BaseForID<Obstacle, si32>
  1135. {
  1136. INSTID_LIKE_CLASS_COMMON(Obstacle, si32)
  1137. DLL_LINKAGE const ObstacleInfo * getInfo() const;
  1138. DLL_LINKAGE operator std::string() const;
  1139. DLL_LINKAGE static Obstacle fromString(const std::string & identifier);
  1140. };
  1141. enum class ESpellSchool: int8_t
  1142. {
  1143. ANY = -1,
  1144. AIR = 0,
  1145. FIRE = 1,
  1146. WATER = 2,
  1147. EARTH = 3,
  1148. };
  1149. using SpellSchool = Identifier<ESpellSchool>;
  1150. enum class EMetaclass: ui8
  1151. {
  1152. INVALID = 0,
  1153. ARTIFACT,
  1154. CREATURE,
  1155. FACTION,
  1156. EXPERIENCE,
  1157. HERO,
  1158. HEROCLASS,
  1159. LUCK,
  1160. MANA,
  1161. MORALE,
  1162. MOVEMENT,
  1163. OBJECT,
  1164. PRIMARY_SKILL,
  1165. SECONDARY_SKILL,
  1166. SPELL,
  1167. RESOURCE
  1168. };
  1169. enum class EHealLevel: ui8
  1170. {
  1171. HEAL,
  1172. RESURRECT,
  1173. OVERHEAL
  1174. };
  1175. enum class EHealPower : ui8
  1176. {
  1177. ONE_BATTLE,
  1178. PERMANENT
  1179. };
  1180. // Typedef declarations
  1181. using TExpType = si64;
  1182. using TQuantity = si32;
  1183. using TRmgTemplateZoneId = int;
  1184. #undef ID_LIKE_CLASS_COMMON
  1185. #undef ID_LIKE_OPERATORS
  1186. #undef ID_LIKE_OPERATORS_INTERNAL
  1187. #undef INSTID_LIKE_CLASS_COMMON
  1188. VCMI_LIB_NAMESPACE_END