GameConstants.h 36 KB

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