GameConstants.h 36 KB

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