GameConstants.h 36 KB

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