GameConstants.h 36 KB

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