NetPacks.h 50 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036
  1. #ifndef __NETPACKS_H__
  2. #define __NETPACKS_H__
  3. #include <boost/unordered_set.hpp>
  4. #include "../global.h"
  5. #include "BattleAction.h"
  6. #include "HeroBonus.h"
  7. #include <set>
  8. #include "CCreatureSet.h"
  9. #include "CMapInfo.h"
  10. #include "../StartInfo.h"
  11. #include "ConstTransitivePtr.h"
  12. #include "../int3.h"
  13. /*
  14. * NetPacks.h, part of VCMI engine
  15. *
  16. * Authors: listed in file AUTHORS in main folder
  17. *
  18. * License: GNU General Public License v2.0 or later
  19. * Full text of license available in license.txt file, in main folder
  20. *
  21. */
  22. class CClient;
  23. class CGameState;
  24. class CGameHandler;
  25. class CConnection;
  26. class CCampaignState;
  27. class CArtifact;
  28. class CSelectionScreen;
  29. class CGObjectInstance;
  30. class CArtifactInstance;
  31. //class CMapInfo;
  32. struct ArtSlotInfo;
  33. struct CPack
  34. {
  35. ui16 type;
  36. CPack(){};
  37. virtual ~CPack(){};
  38. ui16 getType() const{return type;}
  39. template <typename Handler> void serialize(Handler &h, const int version)
  40. {
  41. tlog1 << "CPack serialized... this should not happen!\n";
  42. }
  43. DLL_EXPORT void applyGs(CGameState *gs)
  44. {};
  45. };
  46. struct CPackForClient : public CPack
  47. {
  48. CPackForClient(){type = 1;};
  49. CGameState* GS(CClient *cl);
  50. void applyFirstCl(CClient *cl)//called before applying to gs
  51. {};
  52. void applyCl(CClient *cl)//called after applying to gs
  53. {};
  54. };
  55. struct CPackForServer : public CPack
  56. {
  57. CConnection *c;
  58. CGameState* GS(CGameHandler *gh);
  59. CPackForServer()
  60. {
  61. type = 2;
  62. c = NULL;
  63. };
  64. bool applyGh(CGameHandler *gh);//called after applying to gs
  65. };
  66. struct Query : public CPackForClient
  67. {
  68. ui32 id;
  69. };
  70. struct MetaString : public CPack //2001 helper for object scrips
  71. {
  72. private:
  73. enum EMessage {TEXACT_STRING, TLOCAL_STRING, TNUMBER, TREPLACE_ESTRING, TREPLACE_LSTRING, TREPLACE_NUMBER, TREPLACE_PLUSNUMBER};
  74. public:
  75. enum {GENERAL_TXT=1, XTRAINFO_TXT, OBJ_NAMES, RES_NAMES, ART_NAMES, ARRAY_TXT, CRE_PL_NAMES, CREGENS, MINE_NAMES,
  76. MINE_EVNTS, ADVOB_TXT, ART_EVNTS, SPELL_NAME, SEC_SKILL_NAME, CRE_SING_NAMES, CREGENS4, COLOR, ART_DESCR};
  77. std::vector<ui8> message; //vector of EMessage
  78. std::vector<std::pair<ui8,ui32> > localStrings; //pairs<text handler type, text number>; types: 1 - generaltexthandler->all; 2 - objh->xtrainfo; 3 - objh->names; 4 - objh->restypes; 5 - arth->artifacts[id].name; 6 - generaltexth->arraytxt; 7 - creh->creatures[os->subID].namePl; 8 - objh->creGens; 9 - objh->mines[ID]->first; 10 - objh->mines[ID]->second; 11 - objh->advobtxt
  79. std::vector<std::string> exactStrings;
  80. std::vector<si32> numbers;
  81. template <typename Handler> void serialize(Handler &h, const int version)
  82. {
  83. h & exactStrings & localStrings & message & numbers;
  84. }
  85. void addTxt(ui8 type, ui32 serial)
  86. {
  87. message.push_back(TLOCAL_STRING);
  88. localStrings.push_back(std::pair<ui8,ui32>(type, serial));
  89. }
  90. MetaString& operator<<(const std::pair<ui8,ui32> &txt)
  91. {
  92. message.push_back(TLOCAL_STRING);
  93. localStrings.push_back(txt);
  94. return *this;
  95. }
  96. MetaString& operator<<(const std::string &txt)
  97. {
  98. message.push_back(TEXACT_STRING);
  99. exactStrings.push_back(txt);
  100. return *this;
  101. }
  102. MetaString& operator<<(int txt)
  103. {
  104. message.push_back(TNUMBER);
  105. numbers.push_back(txt);
  106. return *this;
  107. }
  108. void addReplacement(ui8 type, ui32 serial)
  109. {
  110. message.push_back(TREPLACE_LSTRING);
  111. localStrings.push_back(std::pair<ui8,ui32>(type, serial));
  112. }
  113. void addReplacement(const std::string &txt)
  114. {
  115. message.push_back(TREPLACE_ESTRING);
  116. exactStrings.push_back(txt);
  117. }
  118. void addReplacement(int txt)
  119. {
  120. message.push_back(TREPLACE_NUMBER);
  121. numbers.push_back(txt);
  122. }
  123. void addReplacement2(int txt)
  124. {
  125. message.push_back(TREPLACE_PLUSNUMBER);
  126. numbers.push_back(txt);
  127. }
  128. DLL_EXPORT void addCreReplacement(TCreature id, TQuantity count); //adds sing or plural name;
  129. DLL_EXPORT void addReplacement(const CStackBasicDescriptor &stack); //adds sing or plural name;
  130. DLL_EXPORT std::string buildList () const;
  131. void clear()
  132. {
  133. exactStrings.clear();
  134. localStrings.clear();
  135. message.clear();
  136. numbers.clear();
  137. }
  138. DLL_EXPORT void toString(std::string &dst) const;
  139. DLL_EXPORT std::string toString() const;
  140. void getLocalString(const std::pair<ui8,ui32> &txt, std::string &dst) const;
  141. MetaString()
  142. {
  143. type = 2001;
  144. }
  145. };
  146. /***********************************************************************************************************/
  147. struct PackageApplied : public CPackForClient //94
  148. {
  149. PackageApplied() {type = 94;}
  150. PackageApplied(ui8 Result) : result(Result) {type = 94;}
  151. void applyCl(CClient *cl);
  152. ui8 result; //0 - something went wrong, request hasn't been realized; 1 - OK
  153. ui32 packType; //type id of applied package
  154. template <typename Handler> void serialize(Handler &h, const int version)
  155. {
  156. h & result & packType;
  157. }
  158. };
  159. struct SystemMessage : public CPackForClient //95
  160. {
  161. SystemMessage(const std::string Text) : text(Text){type = 95;};
  162. SystemMessage(){type = 95;};
  163. void applyCl(CClient *cl);
  164. std::string text;
  165. template <typename Handler> void serialize(Handler &h, const int version)
  166. {
  167. h & text;
  168. }
  169. };
  170. struct PlayerBlocked : public CPackForClient //96
  171. {
  172. PlayerBlocked(){type = 96;};
  173. void applyCl(CClient *cl);
  174. enum EReason { UPCOMING_BATTLE };
  175. ui8 reason;
  176. ui8 player;
  177. template <typename Handler> void serialize(Handler &h, const int version)
  178. {
  179. h & reason & player;
  180. }
  181. };
  182. struct YourTurn : public CPackForClient //100
  183. {
  184. YourTurn(){type = 100;};
  185. void applyCl(CClient *cl);
  186. DLL_EXPORT void applyGs(CGameState *gs);
  187. ui8 player;
  188. template <typename Handler> void serialize(Handler &h, const int version)
  189. {
  190. h & player;
  191. }
  192. };
  193. struct SetResource : public CPackForClient //102
  194. {
  195. SetResource(){type = 102;};
  196. void applyCl(CClient *cl);
  197. DLL_EXPORT void applyGs(CGameState *gs);
  198. ui8 player, resid;
  199. si32 val;
  200. template <typename Handler> void serialize(Handler &h, const int version)
  201. {
  202. h & player & resid & val;
  203. }
  204. };
  205. struct SetResources : public CPackForClient //104
  206. {
  207. SetResources(){res.resize(RESOURCE_QUANTITY);type = 104;};
  208. void applyCl(CClient *cl);
  209. DLL_EXPORT void applyGs(CGameState *gs);
  210. ui8 player;
  211. std::vector<si32> res; //res[resid] => res amount
  212. template <typename Handler> void serialize(Handler &h, const int version)
  213. {
  214. h & player & res;
  215. }
  216. };
  217. struct SetPrimSkill : public CPackForClient //105
  218. {
  219. SetPrimSkill(){type = 105;};
  220. void applyCl(CClient *cl);
  221. DLL_EXPORT void applyGs(CGameState *gs);
  222. ui8 abs; //0 - changes by value; 1 - sets to value
  223. si32 id;
  224. ui16 which;
  225. si64 val;
  226. template <typename Handler> void serialize(Handler &h, const int version)
  227. {
  228. h & abs & id & which & val;
  229. }
  230. };
  231. struct SetSecSkill : public CPackForClient //106
  232. {
  233. SetSecSkill(){type = 106;};
  234. void applyCl(CClient *cl);
  235. DLL_EXPORT void applyGs(CGameState *gs);
  236. ui8 abs; //0 - changes by value; 1 - sets to value
  237. si32 id;
  238. ui16 which, val;
  239. template <typename Handler> void serialize(Handler &h, const int version)
  240. {
  241. h & abs & id & which & val;
  242. }
  243. };
  244. struct HeroVisitCastle : public CPackForClient //108
  245. {
  246. HeroVisitCastle(){flags=0;type = 108;};
  247. void applyCl(CClient *cl);
  248. DLL_EXPORT void applyGs(CGameState *gs);
  249. ui8 flags; //1 - start
  250. ui32 tid, hid;
  251. bool start() //if hero is entering castle (if false - leaving)
  252. {
  253. return flags & 1;
  254. }
  255. // bool garrison() //if hero is entering/leaving garrison (if false - it's only visiting hero)
  256. // {
  257. // return flags & 2;
  258. // }
  259. template <typename Handler> void serialize(Handler &h, const int version)
  260. {
  261. h & flags & tid & hid;
  262. }
  263. };
  264. struct ChangeSpells : public CPackForClient //109
  265. {
  266. ChangeSpells(){type = 109;};
  267. void applyCl(CClient *cl);
  268. DLL_EXPORT void applyGs(CGameState *gs);
  269. ui8 learn; //1 - gives spell, 0 - takes
  270. ui32 hid;
  271. std::set<ui32> spells;
  272. template <typename Handler> void serialize(Handler &h, const int version)
  273. {
  274. h & learn & hid & spells;
  275. }
  276. };
  277. struct SetMana : public CPackForClient //110
  278. {
  279. SetMana(){type = 110;};
  280. void applyCl(CClient *cl);
  281. DLL_EXPORT void applyGs(CGameState *gs);
  282. si32 hid, val;
  283. template <typename Handler> void serialize(Handler &h, const int version)
  284. {
  285. h & val & hid;
  286. }
  287. };
  288. struct SetMovePoints : public CPackForClient //111
  289. {
  290. SetMovePoints(){type = 111;};
  291. void applyCl(CClient *cl);
  292. DLL_EXPORT void applyGs(CGameState *gs);
  293. ui32 hid, val;
  294. template <typename Handler> void serialize(Handler &h, const int version)
  295. {
  296. h & val & hid;
  297. }
  298. };
  299. struct FoWChange : public CPackForClient //112
  300. {
  301. FoWChange(){type = 112;};
  302. void applyCl(CClient *cl);
  303. DLL_EXPORT void applyGs(CGameState *gs);
  304. boost::unordered_set<int3, struct ShashInt3 > tiles;
  305. ui8 player, mode; //mode==0 - hide, mode==1 - reveal
  306. template <typename Handler> void serialize(Handler &h, const int version)
  307. {
  308. h & tiles & player & mode;
  309. }
  310. };
  311. struct SetAvailableHeroes : public CPackForClient //113
  312. {
  313. SetAvailableHeroes()
  314. {
  315. type = 113;
  316. for (int i = 0; i < AVAILABLE_HEROES_PER_PLAYER; i++)
  317. army[i].clear();
  318. }
  319. ~SetAvailableHeroes()
  320. {
  321. }
  322. void applyCl(CClient *cl);
  323. DLL_EXPORT void applyGs(CGameState *gs);
  324. ui8 player;
  325. si32 hid[AVAILABLE_HEROES_PER_PLAYER]; //-1 if no hero
  326. CSimpleArmy army[AVAILABLE_HEROES_PER_PLAYER];
  327. template <typename Handler> void serialize(Handler &h, const int version)
  328. {
  329. h & player & hid & army;
  330. }
  331. };
  332. struct GiveBonus : public CPackForClient //115
  333. {
  334. GiveBonus(ui8 Who = 0)
  335. {
  336. who = Who;
  337. type = 115;
  338. }
  339. void applyCl(CClient *cl);
  340. DLL_EXPORT void applyGs(CGameState *gs);
  341. enum {HERO, PLAYER, TOWN};
  342. ui8 who; //who receives bonus, uses enum above
  343. ui32 id; //hero. town or player id - whoever receives it
  344. Bonus bonus;
  345. MetaString bdescr;
  346. template <typename Handler> void serialize(Handler &h, const int version)
  347. {
  348. h & bonus & id & bdescr & who;
  349. }
  350. };
  351. struct ChangeObjPos : public CPackForClient //116
  352. {
  353. ChangeObjPos()
  354. {
  355. type = 116;
  356. flags = 0;
  357. }
  358. void applyFirstCl(CClient *cl);
  359. void applyCl(CClient *cl);
  360. DLL_EXPORT void applyGs(CGameState *gs);
  361. ui32 objid;
  362. int3 nPos;
  363. ui8 flags; //bit flags: 1 - redraw
  364. template <typename Handler> void serialize(Handler &h, const int version)
  365. {
  366. h & objid & nPos & flags;
  367. }
  368. };
  369. struct PlayerEndsGame : public CPackForClient //117
  370. {
  371. PlayerEndsGame()
  372. {
  373. type = 117;
  374. }
  375. void applyCl(CClient *cl);
  376. DLL_EXPORT void applyGs(CGameState *gs);
  377. ui8 player;
  378. ui8 victory;
  379. template <typename Handler> void serialize(Handler &h, const int version)
  380. {
  381. h & player & victory;
  382. }
  383. };
  384. struct RemoveBonus : public CPackForClient //118
  385. {
  386. RemoveBonus(ui8 Who = 0)
  387. {
  388. who = Who;
  389. type = 118;
  390. }
  391. void applyCl(CClient *cl);
  392. DLL_EXPORT void applyGs(CGameState *gs);
  393. enum {HERO, PLAYER, TOWN};
  394. ui8 who; //who receives bonus, uses enum above
  395. ui32 whoID; //hero, town or player id - whoever loses bonus
  396. //vars to identify bonus: its source
  397. ui8 source;
  398. ui32 id; //source id
  399. //used locally: copy of removed bonus
  400. Bonus bonus;
  401. template <typename Handler> void serialize(Handler &h, const int version)
  402. {
  403. h & source & id & who & whoID;
  404. }
  405. };
  406. struct UpdateCampaignState : public CPackForClient //119
  407. {
  408. UpdateCampaignState()
  409. {
  410. type = 119;
  411. }
  412. CCampaignState *camp;
  413. void applyCl(CClient *cl);
  414. template <typename Handler> void serialize(Handler &h, const int version)
  415. {
  416. h & camp;
  417. }
  418. };
  419. struct RemoveObject : public CPackForClient //500
  420. {
  421. RemoveObject(){type = 500;};
  422. RemoveObject(si32 ID){id = ID;type = 500;};
  423. void applyFirstCl(CClient *cl);
  424. void applyCl(CClient *cl);
  425. DLL_EXPORT void applyGs(CGameState *gs);
  426. si32 id;
  427. template <typename Handler> void serialize(Handler &h, const int version)
  428. {
  429. h & id;
  430. }
  431. };
  432. struct TryMoveHero : public CPackForClient //501
  433. {
  434. TryMoveHero(){type = 501;humanKnows=false; attackedFrom = int3(-1, -1, -1);};
  435. void applyFirstCl(CClient *cl);
  436. void applyCl(CClient *cl);
  437. void applyGs(CGameState *gs);
  438. enum EResult
  439. {
  440. FAILED, SUCCESS, TELEPORTATION, RESERVED___, BLOCKING_VISIT, EMBARK, DISEMBARK
  441. };
  442. ui32 id, movePoints;
  443. ui8 result; //uses EResult
  444. int3 start, end; //h3m format
  445. boost::unordered_set<int3, ShashInt3> fowRevealed; //revealed tiles
  446. int3 attackedFrom; // Set when stepping into endangered tile.
  447. bool humanKnows; //used locally during applying to client
  448. template <typename Handler> void serialize(Handler &h, const int version)
  449. {
  450. h & id & result & start & end & movePoints & fowRevealed & attackedFrom;
  451. }
  452. };
  453. // struct SetGarrisons : public CPackForClient //502
  454. // {
  455. // SetGarrisons(){type = 502;};
  456. // void applyCl(CClient *cl);
  457. // DLL_EXPORT void applyGs(CGameState *gs);
  458. //
  459. // std::map<ui32,CCreatureSet> garrs;
  460. //
  461. // template <typename Handler> void serialize(Handler &h, const int version)
  462. // {
  463. // h & garrs;
  464. // }
  465. // };
  466. struct NewStructures : public CPackForClient //504
  467. {
  468. NewStructures(){type = 504;};
  469. void applyCl(CClient *cl);
  470. DLL_EXPORT virtual void applyGs(CGameState *gs);
  471. si32 tid;
  472. std::set<si32> bid;
  473. si16 builded;
  474. template <typename Handler> void serialize(Handler &h, const int version)
  475. {
  476. h & tid & bid & builded;
  477. }
  478. };
  479. struct RazeStructures : public CPackForClient //505
  480. {
  481. RazeStructures() {type = 505;};
  482. void applyCl (CClient *cl);
  483. DLL_EXPORT void applyGs(CGameState *gs);
  484. si32 tid;
  485. std::set<si32> bid;
  486. si16 destroyed;
  487. template <typename Handler> void serialize(Handler &h, const int version)
  488. {
  489. h & tid & bid & destroyed;
  490. }
  491. };
  492. struct SetAvailableCreatures : public CPackForClient //506
  493. {
  494. SetAvailableCreatures(){type = 506;};
  495. void applyCl(CClient *cl);
  496. DLL_EXPORT void applyGs(CGameState *gs);
  497. si32 tid;
  498. std::vector<std::pair<ui32, std::vector<ui32> > > creatures;
  499. template <typename Handler> void serialize(Handler &h, const int version)
  500. {
  501. h & tid & creatures;
  502. }
  503. };
  504. struct SetHeroesInTown : public CPackForClient //508
  505. {
  506. SetHeroesInTown(){type = 508;};
  507. void applyCl(CClient *cl);
  508. DLL_EXPORT void applyGs(CGameState *gs);
  509. si32 tid, visiting, garrison; //id of town, visiting hero, hero in garrison
  510. template <typename Handler> void serialize(Handler &h, const int version)
  511. {
  512. h & tid & visiting & garrison;
  513. }
  514. };
  515. // struct SetHeroArtifacts : public CPackForClient //509
  516. // {
  517. // SetHeroArtifacts(){type = 509;};
  518. // void applyCl(CClient *cl);
  519. // DLL_EXPORT void applyGs(CGameState *gs);
  520. // DLL_EXPORT void setArtAtPos(ui16 pos, const CArtifact* art);
  521. //
  522. // si32 hid;
  523. // std::vector<const CArtifact*> artifacts; //hero's artifacts from bag
  524. // std::map<ui16, const CArtifact*> artifWorn; //map<position,artifact_id>; positions: 0 - head; 1 - shoulders; 2 - neck; 3 - right hand; 4 - left hand; 5 - torso; 6 - right ring; 7 - left ring; 8 - feet; 9 - misc1; 10 - misc2; 11 - misc3; 12 - misc4; 13 - mach1; 14 - mach2; 15 - mach3; 16 - mach4; 17 - spellbook; 18 - misc5
  525. //
  526. // template <typename Handler> void serialize(Handler &h, const int version)
  527. // {
  528. // h & hid & artifacts & artifWorn;
  529. // }
  530. //
  531. // std::vector<const CArtifact*> equiped, unequiped; //used locally
  532. // BonusList gained, lost; //used locally as hlp when applying
  533. // };
  534. struct HeroRecruited : public CPackForClient //515
  535. {
  536. HeroRecruited(){type = 515;};
  537. void applyCl(CClient *cl);
  538. DLL_EXPORT void applyGs(CGameState *gs);
  539. si32 hid, tid; //subID of hero
  540. int3 tile;
  541. ui8 player;
  542. template <typename Handler> void serialize(Handler &h, const int version)
  543. {
  544. h & hid & tid & tile & player;
  545. }
  546. };
  547. struct GiveHero : public CPackForClient //516
  548. {
  549. GiveHero(){type = 516;};
  550. void applyFirstCl(CClient *cl);
  551. void applyCl(CClient *cl);
  552. DLL_EXPORT void applyGs(CGameState *gs);
  553. ui32 id; //object id
  554. ui8 player;
  555. template <typename Handler> void serialize(Handler &h, const int version)
  556. {
  557. h & id & player;
  558. }
  559. };
  560. struct OpenWindow : public CPackForClient //517
  561. {
  562. OpenWindow(){type = 517;};
  563. void applyCl(CClient *cl);
  564. enum EWindow {EXCHANGE_WINDOW, RECRUITMENT_FIRST, RECRUITMENT_ALL, SHIPYARD_WINDOW, THIEVES_GUILD,
  565. UNIVERSITY_WINDOW, HILL_FORT_WINDOW, MARKET_WINDOW, PUZZLE_MAP, TAVERN_WINDOW};
  566. ui8 window;
  567. ui32 id1, id2;
  568. template <typename Handler> void serialize(Handler &h, const int version)
  569. {
  570. h & window & id1 & id2;
  571. }
  572. };
  573. struct NewObject : public CPackForClient //518
  574. {
  575. NewObject(){type = 518;};
  576. void applyCl(CClient *cl);
  577. DLL_EXPORT void applyGs(CGameState *gs);
  578. ui32 ID, subID;
  579. int3 pos;
  580. int id; //used internally
  581. template <typename Handler> void serialize(Handler &h, const int version)
  582. {
  583. h & ID & subID & pos;
  584. }
  585. };
  586. struct SetAvailableArtifacts : public CPackForClient //519
  587. {
  588. SetAvailableArtifacts(){type = 519;};
  589. void applyCl(CClient *cl);
  590. DLL_EXPORT void applyGs(CGameState *gs);
  591. si32 id; //two variants: id < 0: set artifact pool for Artifact Merchants in towns; id >= 0: set pool for adv. map Black Market (id is the id of Black Market instance then)
  592. std::vector<const CArtifact *> arts;
  593. template <typename Handler> void serialize(Handler &h, const int version)
  594. {
  595. h & id & arts;
  596. }
  597. };
  598. struct NewArtifact : public CPackForClient //520
  599. {
  600. NewArtifact(){type = 520;};
  601. //void applyCl(CClient *cl);
  602. DLL_EXPORT void applyGs(CGameState *gs);
  603. ConstTransitivePtr<CArtifactInstance> art;
  604. template <typename Handler> void serialize(Handler &h, const int version)
  605. {
  606. h & art;
  607. }
  608. };
  609. struct StackLocation
  610. {
  611. ConstTransitivePtr<CArmedInstance> army;
  612. TSlot slot;
  613. StackLocation()
  614. {
  615. slot = -1;
  616. }
  617. StackLocation(const CArmedInstance *Army, TSlot Slot)
  618. {
  619. army = const_cast<CArmedInstance*>(Army); //we are allowed here to const cast -> change will go through one of our packages... do not abuse!
  620. slot = Slot;
  621. }
  622. DLL_EXPORT const CStackInstance *getStack();
  623. template <typename Handler> void serialize(Handler &h, const int version)
  624. {
  625. h & army & slot;
  626. }
  627. };
  628. struct CGarrisonOperationPack : CPackForClient
  629. {
  630. };
  631. struct CArtifactOperationPack : CPackForClient
  632. {
  633. };
  634. struct ChangeStackCount : CGarrisonOperationPack //521
  635. {
  636. StackLocation sl;
  637. TQuantity count;
  638. ui8 absoluteValue; //if not -> count will be added (or subtracted if negative)
  639. void applyCl(CClient *cl);
  640. DLL_EXPORT void applyGs(CGameState *gs);
  641. template <typename Handler> void serialize(Handler &h, const int version)
  642. {
  643. h & sl & count & absoluteValue;
  644. }
  645. };
  646. struct SetStackType : CGarrisonOperationPack //522
  647. {
  648. StackLocation sl;
  649. CCreature *type;
  650. void applyCl(CClient *cl);
  651. DLL_EXPORT void applyGs(CGameState *gs);
  652. template <typename Handler> void serialize(Handler &h, const int version)
  653. {
  654. h & sl & type;
  655. }
  656. };
  657. struct EraseStack : CGarrisonOperationPack //523
  658. {
  659. StackLocation sl;
  660. void applyCl(CClient *cl);
  661. DLL_EXPORT void applyGs(CGameState *gs);
  662. template <typename Handler> void serialize(Handler &h, const int version)
  663. {
  664. h & sl;
  665. }
  666. };
  667. struct SwapStacks : CGarrisonOperationPack //524
  668. {
  669. StackLocation sl1, sl2;
  670. void applyCl(CClient *cl);
  671. DLL_EXPORT void applyGs(CGameState *gs);
  672. template <typename Handler> void serialize(Handler &h, const int version)
  673. {
  674. h & sl1 & sl2;
  675. }
  676. };
  677. struct InsertNewStack : CGarrisonOperationPack //525
  678. {
  679. StackLocation sl;
  680. CStackBasicDescriptor stack;
  681. void applyCl(CClient *cl);
  682. DLL_EXPORT void applyGs(CGameState *gs);
  683. template <typename Handler> void serialize(Handler &h, const int version)
  684. {
  685. h & sl & stack;
  686. }
  687. };
  688. //moves creatures from src stack to dst slot, may be used for merging/splittint/moving stacks
  689. struct RebalanceStacks : CGarrisonOperationPack //526
  690. {
  691. StackLocation src, dst;
  692. TQuantity count;
  693. void applyCl(CClient *cl);
  694. DLL_EXPORT void applyGs(CGameState *gs);
  695. template <typename Handler> void serialize(Handler &h, const int version)
  696. {
  697. h & src & dst & count;
  698. }
  699. };
  700. typedef si32 TArtPos;
  701. struct ArtifactLocation
  702. {
  703. ConstTransitivePtr<CGHeroInstance> hero;
  704. TArtPos slot;
  705. ArtifactLocation()
  706. {
  707. slot = -1;
  708. }
  709. ArtifactLocation(const CGHeroInstance *Hero, TArtPos Slot)
  710. {
  711. hero = const_cast<CGHeroInstance*>(Hero); //we are allowed here to const cast -> change will go through one of our packages... do not abuse!
  712. slot = Slot;
  713. }
  714. DLL_EXPORT const CArtifactInstance *getArt() const;
  715. DLL_EXPORT CArtifactInstance *getArt();
  716. DLL_EXPORT const ArtSlotInfo *getSlot() const;
  717. template <typename Handler> void serialize(Handler &h, const int version)
  718. {
  719. h & hero & slot;
  720. }
  721. };
  722. struct PutArtifact : CArtifactOperationPack //526
  723. {
  724. ArtifactLocation al;
  725. ConstTransitivePtr<CArtifactInstance> art;
  726. void applyCl(CClient *cl);
  727. DLL_EXPORT void applyGs(CGameState *gs);
  728. template <typename Handler> void serialize(Handler &h, const int version)
  729. {
  730. h & al & art;
  731. }
  732. };
  733. struct EraseArtifact : CArtifactOperationPack //527
  734. {
  735. ArtifactLocation al;
  736. void applyCl(CClient *cl);
  737. DLL_EXPORT void applyGs(CGameState *gs);
  738. template <typename Handler> void serialize(Handler &h, const int version)
  739. {
  740. h & al;
  741. }
  742. };
  743. struct MoveArtifact : CArtifactOperationPack //528
  744. {
  745. ArtifactLocation src, dst;
  746. void applyCl(CClient *cl);
  747. DLL_EXPORT void applyGs(CGameState *gs);
  748. template <typename Handler> void serialize(Handler &h, const int version)
  749. {
  750. h & src & dst;
  751. }
  752. };
  753. struct AssembledArtifact : CArtifactOperationPack //529
  754. {
  755. ArtifactLocation al; //where assembly will be put
  756. CArtifact *builtArt;
  757. //std::vector<CArtifactInstance *> constituents;
  758. void applyCl(CClient *cl);
  759. DLL_EXPORT void applyGs(CGameState *gs);
  760. template <typename Handler> void serialize(Handler &h, const int version)
  761. {
  762. h & al & builtArt/* & constituents*/;
  763. }
  764. };
  765. struct DisassembledArtifact : CArtifactOperationPack //530
  766. {
  767. ArtifactLocation al;
  768. void applyCl(CClient *cl);
  769. DLL_EXPORT void applyGs(CGameState *gs);
  770. template <typename Handler> void serialize(Handler &h, const int version)
  771. {
  772. h & al;
  773. }
  774. };
  775. struct NewTurn : public CPackForClient //101
  776. {
  777. enum weekType {NORMAL, DOUBLE_GROWTH, BONUS_GROWTH, DEITYOFFIRE, PLAGUE, CUSTOM, NO_ACTION, NONE};
  778. DLL_EXPORT void applyGs(CGameState *gs);
  779. struct Hero
  780. {
  781. ui32 id, move, mana; //id is a general serial id
  782. template <typename Handler> void serialize(Handler &h, const int version)
  783. {
  784. h & id & move & mana;
  785. }
  786. bool operator<(const Hero&h)const{return id < h.id;}
  787. };
  788. std::set<Hero> heroes; //updates movement and mana points
  789. //std::vector<SetResources> res;//resource list
  790. std::map<ui8, std::vector<si32> > res; //player ID => resource value[res_id]
  791. std::vector<SetAvailableCreatures> cres;//creatures to be placed in towns
  792. ui32 day;
  793. bool resetBuilded;
  794. ui8 specialWeek; //weekType
  795. TCreature creatureid; //for creature weeks
  796. NewTurn(){type = 101;};
  797. template <typename Handler> void serialize(Handler &h, const int version)
  798. {
  799. h & heroes & cres & res & day & resetBuilded & specialWeek & creatureid;
  800. }
  801. };
  802. struct Component : public CPack //2002 helper for object scrips informations
  803. {
  804. enum EComponentType {PRIM_SKILL, SEC_SKILL, RESOURCE, CREATURE, ARTIFACT, EXPERIENCE, SPELL, MORALE=8, LUCK, BUILDING, HERO, FLAG};
  805. ui16 id, subtype; //id uses ^^^ enums, when id==EXPPERIENCE subtype==0 means exp points and subtype==1 levels)
  806. si32 val; // + give; - take
  807. si16 when; // 0 - now; +x - within x days; -x - per x days
  808. template <typename Handler> void serialize(Handler &h, const int version)
  809. {
  810. h & id & subtype & val & when;
  811. }
  812. Component()
  813. {
  814. type = 2002;
  815. }
  816. DLL_EXPORT explicit Component(const CStackBasicDescriptor &stack);
  817. Component(ui16 Type, ui16 Subtype, si32 Val, si16 When)
  818. :id(Type),subtype(Subtype),val(Val),when(When)
  819. {
  820. type = 2002;
  821. }
  822. };
  823. struct InfoWindow : public CPackForClient //103 - displays simple info window
  824. {
  825. void applyCl(CClient *cl);
  826. MetaString text;
  827. std::vector<Component> components;
  828. ui8 player;
  829. ui16 soundID;
  830. template <typename Handler> void serialize(Handler &h, const int version)
  831. {
  832. h & text & components & player & soundID;
  833. }
  834. InfoWindow()
  835. {
  836. type = 103;
  837. soundID = 0;
  838. }
  839. };
  840. namespace ObjProperty
  841. {
  842. //TODO: move non general properties out to the appropriate objs classes
  843. enum {OWNER = 1, BLOCKVIS = 2, PRIMARY_STACK_COUNT = 3, VISITORS = 4, VISITED = 5, ID = 6, AVAILABLE_CREATURE = 7, SUBID = 8};
  844. }
  845. struct SetObjectProperty : public CPackForClient//1001
  846. {
  847. DLL_EXPORT void applyGs(CGameState *gs);
  848. void applyCl(CClient *cl);
  849. ui32 id;
  850. ui8 what; //1 - owner; 2 - blockvis; 3 - first stack count; 4 - visitors; 5 - visited; 6 - ID (if 34 then also def is replaced)
  851. ui32 val;
  852. SetObjectProperty(){type = 1001;};
  853. SetObjectProperty(ui32 ID, ui8 What, ui32 Val):id(ID),what(What),val(Val){type = 1001;};
  854. template <typename Handler> void serialize(Handler &h, const int version)
  855. {
  856. h & id & what & val;
  857. }
  858. };
  859. struct SetHoverName : public CPackForClient//1002
  860. {
  861. DLL_EXPORT void applyGs(CGameState *gs);
  862. ui32 id;
  863. MetaString name;
  864. SetHoverName(){type = 1002;};
  865. SetHoverName(ui32 ID, MetaString& Name):id(ID),name(Name){type = 1002;};
  866. template <typename Handler> void serialize(Handler &h, const int version)
  867. {
  868. h & id & name;
  869. }
  870. };
  871. struct HeroLevelUp : public Query//2000
  872. {
  873. void applyCl(CClient *cl);
  874. DLL_EXPORT void applyGs(CGameState *gs);
  875. si32 heroid;
  876. ui8 primskill, level;
  877. std::vector<ui16> skills;
  878. HeroLevelUp(){type = 2000;};
  879. template <typename Handler> void serialize(Handler &h, const int version)
  880. {
  881. h & id & heroid & primskill & level & skills;
  882. }
  883. };
  884. struct TradeComponents : public CPackForClient, public CPackForServer
  885. {
  886. ///used to handle info about components available in shops
  887. void applyCl(CClient *cl);
  888. DLL_EXPORT void applyGs(CGameState *gs);
  889. si32 heroid;
  890. ui32 objectid;
  891. std::map<ui16, Component> available, chosen, bought;
  892. template <typename Handler> void serialize(Handler &h, const int version)
  893. {
  894. h & heroid & objectid & available & chosen & bought;
  895. }
  896. };
  897. //A dialog that requires making decision by player - it may contain components to choose between or has yes/no options
  898. //Client responds with QueryReply, where answer: 0 - cancel pressed, choice doesn't matter; 1/2/... - first/second/... component selected and OK pressed
  899. //Until sending reply player won't be allowed to take any actions
  900. struct BlockingDialog : public Query//2003
  901. {
  902. enum {ALLOW_CANCEL = 1, SELECTION = 2};
  903. void applyCl(CClient *cl);
  904. MetaString text;
  905. std::vector<Component> components;
  906. ui8 player;
  907. ui8 flags;
  908. ui16 soundID;
  909. bool cancel() const
  910. {
  911. return flags & ALLOW_CANCEL;
  912. }
  913. bool selection() const
  914. {
  915. return flags & SELECTION;
  916. }
  917. BlockingDialog(bool yesno, bool Selection)
  918. {
  919. type = 2003;
  920. flags = 0;
  921. soundID = 0;
  922. if(yesno) flags |= ALLOW_CANCEL;
  923. if(Selection) flags |= SELECTION;
  924. }
  925. BlockingDialog()
  926. {
  927. type = 2003;
  928. flags = 0;
  929. soundID = 0;
  930. };
  931. template <typename Handler> void serialize(Handler &h, const int version)
  932. {
  933. h & id & text & components & player & flags & soundID;
  934. }
  935. };
  936. struct GarrisonDialog : public Query//2004
  937. {
  938. GarrisonDialog(){type = 2004;}
  939. void applyCl(CClient *cl);
  940. si32 objid, hid;
  941. bool removableUnits;
  942. template <typename Handler> void serialize(Handler &h, const int version)
  943. {
  944. h & id & objid & hid & removableUnits;
  945. }
  946. };
  947. struct BattleInfo;
  948. struct BattleStart : public CPackForClient//3000
  949. {
  950. BattleStart(){type = 3000;};
  951. void applyCl(CClient *cl);
  952. DLL_EXPORT void applyGs(CGameState *gs);
  953. BattleInfo * info;
  954. template <typename Handler> void serialize(Handler &h, const int version)
  955. {
  956. h & info;
  957. }
  958. };
  959. struct BattleNextRound : public CPackForClient//3001
  960. {
  961. BattleNextRound(){type = 3001;};
  962. void applyFirstCl(CClient *cl);
  963. void applyCl(CClient *cl);
  964. DLL_EXPORT void applyGs( CGameState *gs );
  965. si32 round;
  966. template <typename Handler> void serialize(Handler &h, const int version)
  967. {
  968. h & round;
  969. }
  970. };
  971. struct BattleSetActiveStack : public CPackForClient//3002
  972. {
  973. BattleSetActiveStack(){type = 3002;};
  974. void applyCl(CClient *cl);
  975. DLL_EXPORT void applyGs(CGameState *gs);
  976. ui32 stack;
  977. template <typename Handler> void serialize(Handler &h, const int version)
  978. {
  979. h & stack;
  980. }
  981. };
  982. struct BattleResult : public CPackForClient//3003
  983. {
  984. BattleResult(){type = 3003;};
  985. void applyFirstCl(CClient *cl);
  986. void applyGs(CGameState *gs);
  987. ui8 result; //0 - normal victory; 1 - escape; 2 - surrender
  988. ui8 winner; //0 - attacker, 1 - defender, [2 - draw (should be possible?)]
  989. std::map<ui32,si32> casualties[2]; //first => casualties of attackers - map crid => number
  990. expType exp[2]; //exp for attacker and defender
  991. std::set<ui32> artifacts; //artifacts taken from loser to winner
  992. template <typename Handler> void serialize(Handler &h, const int version)
  993. {
  994. h & result & winner & casualties[0] & casualties[1] & exp & artifacts;
  995. }
  996. };
  997. struct BattleStackMoved : public CPackForClient//3004
  998. {
  999. ui32 stack;
  1000. THex tile;
  1001. ui8 ending, distance, teleporting;
  1002. BattleStackMoved(){type = 3004;};
  1003. void applyFirstCl(CClient *cl);
  1004. void applyGs(CGameState *gs);
  1005. template <typename Handler> void serialize(Handler &h, const int version)
  1006. {
  1007. h & stack & tile & ending & distance;
  1008. }
  1009. };
  1010. struct StacksHealedOrResurrected : public CPackForClient //3013
  1011. {
  1012. StacksHealedOrResurrected(){type = 3013;}
  1013. DLL_EXPORT void applyGs(CGameState *gs);
  1014. void applyCl(CClient *cl);
  1015. struct HealInfo
  1016. {
  1017. ui32 stackID;
  1018. ui32 healedHP;
  1019. ui8 lowLevelResurrection; //in case this stack is resurrected by this heal, it will be marked as SUMMONED
  1020. template <typename Handler> void serialize(Handler &h, const int version)
  1021. {
  1022. h & stackID & healedHP & lowLevelResurrection;
  1023. }
  1024. };
  1025. std::vector<HealInfo> healedStacks;
  1026. ui8 lifeDrain; //if true, this heal is an effect of life drain
  1027. si32 drainedFrom; //if life drain - then stack life was drain from
  1028. template <typename Handler> void serialize(Handler &h, const int version)
  1029. {
  1030. h & healedStacks & lifeDrain & drainedFrom;
  1031. }
  1032. };
  1033. struct BattleStackAttacked : public CPackForClient//3005
  1034. {
  1035. BattleStackAttacked(){flags = 0; type = 3005;};
  1036. void applyCl(CClient *cl);
  1037. DLL_EXPORT void applyGs(CGameState *gs);
  1038. ui32 stackAttacked, attackerID;
  1039. ui32 newAmount, newHP, killedAmount, damageAmount;
  1040. enum EFlags {KILLED = 1, EFFECT = 2};
  1041. ui8 flags; //uses EFlags (above)
  1042. ui32 effect; //set only if flag EFFECT is set
  1043. std::vector<StacksHealedOrResurrected> healedStacks; //used when life drain
  1044. bool killed() const//if target stack was killed
  1045. {
  1046. return flags & KILLED;
  1047. }
  1048. bool isEffect() const//if stack has been attacked by a spell
  1049. {
  1050. return flags & EFFECT;
  1051. }
  1052. bool lifeDrain() const //if this attack involves life drain effect
  1053. {
  1054. return healedStacks.size() > 0;
  1055. }
  1056. template <typename Handler> void serialize(Handler &h, const int version)
  1057. {
  1058. h & stackAttacked & attackerID & newAmount & newHP & flags & killedAmount & damageAmount & effect
  1059. & healedStacks;
  1060. }
  1061. bool operator<(const BattleStackAttacked &b) const
  1062. {
  1063. return stackAttacked < b.stackAttacked;
  1064. }
  1065. };
  1066. struct BattleAttack : public CPackForClient//3006
  1067. {
  1068. BattleAttack(){flags = 0; type = 3006;};
  1069. void applyFirstCl(CClient *cl);
  1070. DLL_EXPORT void applyGs(CGameState *gs);
  1071. void applyCl(CClient *cl);
  1072. std::vector<BattleStackAttacked> bsa;
  1073. ui32 stackAttacking;
  1074. ui8 flags; //usues Eflags (below)
  1075. enum EFlags{SHOT = 1, COUNTER = 2, LUCKY = 4, UNLUCKY = 8, BALLISTA_DOUBLE_DMG = 16};
  1076. bool shot() const//distance attack - decrease number of shots
  1077. {
  1078. return flags & SHOT;
  1079. }
  1080. bool counter() const//is it counterattack?
  1081. {
  1082. return flags & COUNTER;
  1083. }
  1084. bool lucky() const
  1085. {
  1086. return flags & LUCKY;
  1087. }
  1088. bool unlucky() const
  1089. {
  1090. //TODO: support?
  1091. return flags & UNLUCKY;
  1092. }
  1093. bool ballistaDoubleDmg() const //if it's ballista attack and does double dmg
  1094. {
  1095. return flags & BALLISTA_DOUBLE_DMG;
  1096. }
  1097. //bool killed() //if target stack was killed
  1098. //{
  1099. // return bsa.killed();
  1100. //}
  1101. template <typename Handler> void serialize(Handler &h, const int version)
  1102. {
  1103. h & bsa & stackAttacking & flags;
  1104. }
  1105. };
  1106. struct StartAction : public CPackForClient//3007
  1107. {
  1108. StartAction(){type = 3007;};
  1109. StartAction(const BattleAction &act){ba = act; type = 3007;};
  1110. void applyFirstCl(CClient *cl);
  1111. DLL_EXPORT void applyGs(CGameState *gs);
  1112. BattleAction ba;
  1113. template <typename Handler> void serialize(Handler &h, const int version)
  1114. {
  1115. h & ba;
  1116. }
  1117. };
  1118. struct EndAction : public CPackForClient//3008
  1119. {
  1120. EndAction(){type = 3008;};
  1121. void applyCl(CClient *cl);
  1122. template <typename Handler> void serialize(Handler &h, const int version)
  1123. {
  1124. }
  1125. };
  1126. struct BattleSpellCast : public CPackForClient//3009
  1127. {
  1128. BattleSpellCast(){type = 3009;};
  1129. DLL_EXPORT void applyGs(CGameState *gs);
  1130. void applyCl(CClient *cl);
  1131. si32 dmgToDisplay; //this amount will be displayed as amount of damage dealt by spell
  1132. ui8 side; //which hero did cast spell: 0 - attacker, 1 - defender
  1133. ui32 id; //id of spell
  1134. ui8 skill; //caster's skill level
  1135. ui16 tile; //destination tile (may not be set in some global/mass spells
  1136. std::vector<ui32> resisted; //ids of creatures that resisted this spell
  1137. std::set<ui32> affectedCres; //ids of creatures affected by this spell, generally used if spell does not set any effect (like dispel or cure)
  1138. ui8 castedByHero; //if true - spell has been casted by hero, otherwise by a creature
  1139. template <typename Handler> void serialize(Handler &h, const int version)
  1140. {
  1141. h & dmgToDisplay & side & id & skill & tile & resisted & affectedCres & castedByHero;
  1142. }
  1143. };
  1144. struct SetStackEffect : public CPackForClient //3010
  1145. {
  1146. SetStackEffect(){type = 3010;};
  1147. DLL_EXPORT void applyGs(CGameState *gs);
  1148. void applyCl(CClient *cl);
  1149. std::vector<ui32> stacks; //affected stacks (IDs)
  1150. std::vector<Bonus> effect; //bonuses to apply
  1151. template <typename Handler> void serialize(Handler &h, const int version)
  1152. {
  1153. h & stacks & effect;
  1154. }
  1155. };
  1156. struct StacksInjured : public CPackForClient //3011
  1157. {
  1158. StacksInjured(){type = 3011;}
  1159. DLL_EXPORT void applyGs(CGameState *gs);
  1160. void applyCl(CClient *cl);
  1161. std::vector<BattleStackAttacked> stacks;
  1162. template <typename Handler> void serialize(Handler &h, const int version)
  1163. {
  1164. h & stacks;
  1165. }
  1166. };
  1167. struct BattleResultsApplied : public CPackForClient //3012
  1168. {
  1169. BattleResultsApplied(){type = 3012;}
  1170. ui8 player1, player2;
  1171. void applyCl(CClient *cl);
  1172. template <typename Handler> void serialize(Handler &h, const int version)
  1173. {
  1174. h & player1 & player2;
  1175. }
  1176. };
  1177. struct ObstaclesRemoved : public CPackForClient //3014
  1178. {
  1179. ObstaclesRemoved(){type = 3014;}
  1180. DLL_EXPORT void applyGs(CGameState *gs);
  1181. void applyCl(CClient *cl);
  1182. std::set<si32> obstacles; //uniqueIDs of removed obstacles
  1183. template <typename Handler> void serialize(Handler &h, const int version)
  1184. {
  1185. h & obstacles;
  1186. }
  1187. };
  1188. struct CatapultAttack : public CPackForClient //3015
  1189. {
  1190. CatapultAttack(){type = 3015;}
  1191. DLL_EXPORT void applyGs(CGameState *gs);
  1192. void applyCl(CClient *cl);
  1193. std::set< std::pair< std::pair< ui8, si16 >, ui8> > attackedParts; // < <attackedPartOfWall, attacked hex >, damageDealt>
  1194. //attackedPartOfWall; //[0] - keep, [1] - bottom tower, [2] - bottom wall, [3] - below gate, [4] - over gate, [5] - upper wall, [6] - uppert tower, [7] - gate;
  1195. //damageDealt;
  1196. int attacker; //if -1, then a spell caused this
  1197. template <typename Handler> void serialize(Handler &h, const int version)
  1198. {
  1199. h & attackedParts & attacker;
  1200. }
  1201. };
  1202. struct BattleStacksRemoved : public CPackForClient //3016
  1203. {
  1204. BattleStacksRemoved(){type = 3016;}
  1205. DLL_EXPORT void applyGs(CGameState *gs);
  1206. void applyCl(CClient *cl);
  1207. std::set<ui32> stackIDs; //IDs of removed stacks
  1208. template <typename Handler> void serialize(Handler &h, const int version)
  1209. {
  1210. h & stackIDs;
  1211. }
  1212. };
  1213. struct ShowInInfobox : public CPackForClient //107
  1214. {
  1215. ShowInInfobox(){type = 107;};
  1216. ui8 player;
  1217. Component c;
  1218. MetaString text;
  1219. void applyCl(CClient *cl);
  1220. template <typename Handler> void serialize(Handler &h, const int version)
  1221. {
  1222. h & player & c & text;
  1223. }
  1224. };
  1225. struct AdvmapSpellCast : public CPackForClient //108
  1226. {
  1227. AdvmapSpellCast(){type = 108;}
  1228. const CGHeroInstance * caster;
  1229. si32 spellID;
  1230. void applyCl(CClient *cl);
  1231. template <typename Handler> void serialize(Handler &h, const int version)
  1232. {
  1233. h & caster & spellID;
  1234. }
  1235. };
  1236. /***********************************************************************************************************/
  1237. struct CloseServer : public CPackForServer
  1238. {
  1239. bool applyGh(CGameHandler *gh);
  1240. template <typename Handler> void serialize(Handler &h, const int version)
  1241. {}
  1242. };
  1243. struct EndTurn : public CPackForServer
  1244. {
  1245. bool applyGh(CGameHandler *gh);
  1246. template <typename Handler> void serialize(Handler &h, const int version)
  1247. {}
  1248. };
  1249. struct DismissHero : public CPackForServer
  1250. {
  1251. DismissHero(){};
  1252. DismissHero(si32 HID) : hid(HID) {};
  1253. si32 hid;
  1254. bool applyGh(CGameHandler *gh);
  1255. template <typename Handler> void serialize(Handler &h, const int version)
  1256. {
  1257. h & hid;
  1258. }
  1259. };
  1260. struct MoveHero : public CPackForServer
  1261. {
  1262. MoveHero(){};
  1263. MoveHero(const int3 &Dest, si32 HID) : dest(Dest), hid(HID){};
  1264. int3 dest;
  1265. si32 hid;
  1266. bool applyGh(CGameHandler *gh);
  1267. template <typename Handler> void serialize(Handler &h, const int version)
  1268. {
  1269. h & dest & hid;
  1270. }
  1271. };
  1272. struct CastleTeleportHero : public CPackForServer
  1273. {
  1274. CastleTeleportHero(){};
  1275. CastleTeleportHero(const si32 HID, si32 Dest, ui8 Source ) : dest(Dest), hid(HID), source(Source){};
  1276. si32 dest;
  1277. si32 hid;
  1278. si8 source;//who give teleporting, 1=castle gate
  1279. bool applyGh(CGameHandler *gh);
  1280. template <typename Handler> void serialize(Handler &h, const int version)
  1281. {
  1282. h & dest & hid;
  1283. }
  1284. };
  1285. struct ArrangeStacks : public CPackForServer
  1286. {
  1287. ArrangeStacks(){};
  1288. ArrangeStacks(ui8 W, ui8 P1, ui8 P2, si32 ID1, si32 ID2, si32 VAL)
  1289. :what(W),p1(P1),p2(P2),id1(ID1),id2(ID2),val(VAL) {};
  1290. ui8 what; //1 - swap; 2 - merge; 3 - split
  1291. ui8 p1, p2; //positions of first and second stack
  1292. si32 id1, id2; //ids of objects with garrison
  1293. si32 val;
  1294. bool applyGh(CGameHandler *gh);
  1295. template <typename Handler> void serialize(Handler &h, const int version)
  1296. {
  1297. h & what & p1 & p2 & id1 & id2 & val;
  1298. }
  1299. };
  1300. struct DisbandCreature : public CPackForServer
  1301. {
  1302. DisbandCreature(){};
  1303. DisbandCreature(ui8 Pos, si32 ID):pos(Pos),id(ID){};
  1304. ui8 pos; //stack pos
  1305. si32 id; //object id
  1306. bool applyGh(CGameHandler *gh);
  1307. template <typename Handler> void serialize(Handler &h, const int version)
  1308. {
  1309. h & pos & id;
  1310. }
  1311. };
  1312. struct BuildStructure : public CPackForServer
  1313. {
  1314. BuildStructure(){};
  1315. BuildStructure(si32 TID, si32 BID):bid(BID),tid(TID){};
  1316. si32 bid, tid; //structure and town ids
  1317. bool applyGh(CGameHandler *gh);
  1318. template <typename Handler> void serialize(Handler &h, const int version)
  1319. {
  1320. h & tid & bid;
  1321. }
  1322. };
  1323. struct RazeStructure : public BuildStructure
  1324. {
  1325. RazeStructure(){};
  1326. //RazeStructure(si32 TID, si32 BID):bid(BID),tid(TID){};
  1327. bool applyGh(CGameHandler *gh);
  1328. };
  1329. struct RecruitCreatures : public CPackForServer
  1330. {
  1331. RecruitCreatures(){};
  1332. RecruitCreatures(si32 TID, si32 CRID, si32 Amount, si32 Level):tid(TID),crid(CRID),amount(Amount),level(Level){};
  1333. si32 tid; //town id
  1334. ui32 crid, amount;//creature ID and amount
  1335. si32 level;//dwelling level to buy from, -1 if any
  1336. bool applyGh(CGameHandler *gh);
  1337. template <typename Handler> void serialize(Handler &h, const int version)
  1338. {
  1339. h & tid & crid & amount & level;
  1340. }
  1341. };
  1342. struct UpgradeCreature : public CPackForServer
  1343. {
  1344. UpgradeCreature(){};
  1345. UpgradeCreature(ui8 Pos, si32 ID, si32 CRID):pos(Pos),id(ID), cid(CRID){};
  1346. ui8 pos; //stack pos
  1347. si32 id; //object id
  1348. si32 cid; //id of type to which we want make upgrade
  1349. bool applyGh(CGameHandler *gh);
  1350. template <typename Handler> void serialize(Handler &h, const int version)
  1351. {
  1352. h & pos & id & cid;
  1353. }
  1354. };
  1355. struct GarrisonHeroSwap : public CPackForServer
  1356. {
  1357. GarrisonHeroSwap(){};
  1358. GarrisonHeroSwap(si32 TID):tid(TID){};
  1359. si32 tid;
  1360. bool applyGh(CGameHandler *gh);
  1361. template <typename Handler> void serialize(Handler &h, const int version)
  1362. {
  1363. h & tid;
  1364. }
  1365. };
  1366. struct ExchangeArtifacts : public CPackForServer
  1367. {
  1368. ExchangeArtifacts(){};
  1369. ExchangeArtifacts(si32 H1, si32 H2, ui16 S1, ui16 S2)
  1370. :hid1(H1),hid2(H2),slot1(S1),slot2(S2){};
  1371. si32 hid1, hid2;
  1372. ui16 slot1, slot2;
  1373. bool applyGh(CGameHandler *gh);
  1374. template <typename Handler> void serialize(Handler &h, const int version)
  1375. {
  1376. h & hid1 & hid2 & slot1 & slot2;
  1377. }
  1378. };
  1379. struct AssembleArtifacts : public CPackForServer
  1380. {
  1381. AssembleArtifacts(){};
  1382. AssembleArtifacts(si32 _heroID, ui16 _artifactSlot, bool _assemble, ui32 _assembleTo)
  1383. : heroID(_heroID), artifactSlot(_artifactSlot), assemble(_assemble), assembleTo(_assembleTo){};
  1384. si32 heroID;
  1385. ui16 artifactSlot;
  1386. bool assemble; // True to assemble artifact, false to disassemble.
  1387. ui32 assembleTo; // Artifact to assemble into.
  1388. bool applyGh(CGameHandler *gh);
  1389. template <typename Handler> void serialize(Handler &h, const int version)
  1390. {
  1391. h & heroID & artifactSlot & assemble & assembleTo;
  1392. }
  1393. };
  1394. struct BuyArtifact : public CPackForServer
  1395. {
  1396. BuyArtifact(){};
  1397. BuyArtifact(si32 HID, si32 AID):hid(HID),aid(AID){};
  1398. si32 hid, aid; //hero and artifact id
  1399. bool applyGh(CGameHandler *gh);
  1400. template <typename Handler> void serialize(Handler &h, const int version)
  1401. {
  1402. h & hid & aid;
  1403. }
  1404. };
  1405. struct TradeOnMarketplace : public CPackForServer
  1406. {
  1407. TradeOnMarketplace(){};
  1408. const CGObjectInstance *market;
  1409. const CGHeroInstance *hero; //needed when trading artifacts / creatures
  1410. ui8 mode;//enum EMarketMode
  1411. ui32 r1, r2; //mode 0: r1 - sold resource, r2 - bought res (exception: when sacrificing art r1 is art id [todo: make r2 preferred slot?]
  1412. ui32 val; //units of sold resource
  1413. bool applyGh(CGameHandler *gh);
  1414. template <typename Handler> void serialize(Handler &h, const int version)
  1415. {
  1416. h & market & hero & mode & r1 & r2 & val;
  1417. }
  1418. };
  1419. struct SetFormation : public CPackForServer
  1420. {
  1421. SetFormation(){};
  1422. SetFormation(si32 HID, ui8 Formation):hid(HID),formation(Formation){};
  1423. si32 hid;
  1424. ui8 formation;
  1425. bool applyGh(CGameHandler *gh);
  1426. template <typename Handler> void serialize(Handler &h, const int version)
  1427. {
  1428. h & hid & formation;
  1429. }
  1430. };
  1431. struct HireHero : public CPackForServer
  1432. {
  1433. HireHero(){};
  1434. HireHero(si32 HID, si32 TID):hid(HID),tid(TID){};
  1435. si32 hid, tid; //available hero serial and town (tavern) id
  1436. ui8 player;
  1437. bool applyGh(CGameHandler *gh);
  1438. template <typename Handler> void serialize(Handler &h, const int version)
  1439. {
  1440. h & hid & tid & player;
  1441. }
  1442. };
  1443. struct BuildBoat : public CPackForServer
  1444. {
  1445. BuildBoat(){};
  1446. si32 objid; //where player wants to buy a boat
  1447. bool applyGh(CGameHandler *gh);
  1448. template <typename Handler> void serialize(Handler &h, const int version)
  1449. {
  1450. h & objid;
  1451. }
  1452. };
  1453. struct QueryReply : public CPackForServer
  1454. {
  1455. QueryReply(){type = 6000;};
  1456. QueryReply(ui32 QID, ui32 Answer):qid(QID),answer(Answer){type = 6000;};
  1457. ui32 qid, answer; //hero and artifact id
  1458. bool applyGh(CGameHandler *gh);
  1459. template <typename Handler> void serialize(Handler &h, const int version)
  1460. {
  1461. h & qid & answer;
  1462. }
  1463. };
  1464. struct MakeAction : public CPackForServer
  1465. {
  1466. MakeAction(){};
  1467. MakeAction(const BattleAction &BA):ba(BA){};
  1468. BattleAction ba;
  1469. bool applyGh(CGameHandler *gh);
  1470. template <typename Handler> void serialize(Handler &h, const int version)
  1471. {
  1472. h & ba;
  1473. }
  1474. };
  1475. struct MakeCustomAction : public CPackForServer
  1476. {
  1477. MakeCustomAction(){};
  1478. MakeCustomAction(const BattleAction &BA):ba(BA){};
  1479. BattleAction ba;
  1480. bool applyGh(CGameHandler *gh);
  1481. template <typename Handler> void serialize(Handler &h, const int version)
  1482. {
  1483. h & ba;
  1484. }
  1485. };
  1486. struct DigWithHero : public CPackForServer
  1487. {
  1488. DigWithHero(){}
  1489. si32 id; //digging hero id
  1490. bool applyGh(CGameHandler *gh);
  1491. template <typename Handler> void serialize(Handler &h, const int version)
  1492. {
  1493. h & id;
  1494. }
  1495. };
  1496. struct CastAdvSpell : public CPackForServer
  1497. {
  1498. CastAdvSpell(){}
  1499. si32 hid; //hero id
  1500. ui32 sid; //spell id
  1501. int3 pos; //selected tile (not always used)
  1502. bool applyGh(CGameHandler *gh);
  1503. template <typename Handler> void serialize(Handler &h, const int version)
  1504. {
  1505. h & hid & sid & pos;
  1506. }
  1507. };
  1508. /***********************************************************************************************************/
  1509. struct SaveGame : public CPackForClient, public CPackForServer
  1510. {
  1511. SaveGame(){};
  1512. SaveGame(const std::string &Fname) :fname(Fname){};
  1513. std::string fname;
  1514. void applyCl(CClient *cl);
  1515. void applyGs(CGameState *gs){};
  1516. bool applyGh(CGameHandler *gh);
  1517. template <typename Handler> void serialize(Handler &h, const int version)
  1518. {
  1519. h & fname;
  1520. }
  1521. };
  1522. struct PlayerMessage : public CPackForClient, public CPackForServer //513
  1523. {
  1524. PlayerMessage(){CPackForClient::type = 513;};
  1525. PlayerMessage(ui8 Player, const std::string &Text)
  1526. :player(Player),text(Text)
  1527. {CPackForClient::type = 513;};
  1528. void applyCl(CClient *cl);
  1529. void applyGs(CGameState *gs){};
  1530. bool applyGh(CGameHandler *gh);
  1531. ui8 player;
  1532. std::string text;
  1533. template <typename Handler> void serialize(Handler &h, const int version)
  1534. {
  1535. h & text & player;
  1536. }
  1537. };
  1538. struct SetSelection : public CPackForClient, public CPackForServer //514
  1539. {
  1540. SetSelection(){CPackForClient::type = 514;};
  1541. DLL_EXPORT void applyGs(CGameState *gs);
  1542. bool applyGh(CGameHandler *gh);
  1543. void applyCl(CClient *cl);
  1544. ui8 player;
  1545. ui32 id;
  1546. template <typename Handler> void serialize(Handler &h, const int version)
  1547. {
  1548. h & id & player;
  1549. }
  1550. };
  1551. struct CenterView : public CPackForClient//515
  1552. {
  1553. CenterView(){CPackForClient::type = 515;};
  1554. void applyCl(CClient *cl);
  1555. ui8 player;
  1556. int3 pos;
  1557. ui32 focusTime; //ms
  1558. template <typename Handler> void serialize(Handler &h, const int version)
  1559. {
  1560. h & pos & player & focusTime;
  1561. }
  1562. };
  1563. /***********************************************************************************************************/
  1564. struct CPackForSelectionScreen : public CPack
  1565. {
  1566. void apply(CSelectionScreen *selScreen){}; //that functions are implemented in CPreGame.cpp
  1567. };
  1568. class CPregamePackToPropagate : public CPackForSelectionScreen
  1569. {};
  1570. class CPregamePackToHost : public CPackForSelectionScreen
  1571. {};
  1572. struct ChatMessage : public CPregamePackToPropagate
  1573. {
  1574. std::string playerName, message;
  1575. void apply(CSelectionScreen *selScreen);
  1576. template <typename Handler> void serialize(Handler &h, const int version)
  1577. {
  1578. h & playerName & message;
  1579. }
  1580. };
  1581. struct QuitMenuWithoutStarting : public CPregamePackToPropagate
  1582. {
  1583. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1584. template <typename Handler> void serialize(Handler &h, const int version)
  1585. {}
  1586. };
  1587. struct PlayerJoined : public CPregamePackToHost
  1588. {
  1589. std::string playerName;
  1590. ui8 connectionID;
  1591. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1592. template <typename Handler> void serialize(Handler &h, const int version)
  1593. {
  1594. h & playerName & connectionID;
  1595. }
  1596. };
  1597. struct SelectMap : public CPregamePackToPropagate
  1598. {
  1599. const CMapInfo *mapInfo;
  1600. bool free;
  1601. SelectMap(const CMapInfo &src)
  1602. {
  1603. mapInfo = &src;
  1604. free = false;
  1605. }
  1606. SelectMap()
  1607. {
  1608. mapInfo = NULL;
  1609. free = true;
  1610. }
  1611. ~SelectMap()
  1612. {
  1613. if(free)
  1614. delete mapInfo;
  1615. }
  1616. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1617. template <typename Handler> void serialize(Handler &h, const int version)
  1618. {
  1619. h & mapInfo;
  1620. }
  1621. };
  1622. struct UpdateStartOptions : public CPregamePackToPropagate
  1623. {
  1624. StartInfo *options;
  1625. bool free;
  1626. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1627. UpdateStartOptions(StartInfo &src)
  1628. {
  1629. options = &src;
  1630. free = false;
  1631. }
  1632. UpdateStartOptions()
  1633. {
  1634. options = NULL;
  1635. free = true;
  1636. }
  1637. ~UpdateStartOptions()
  1638. {
  1639. if(free)
  1640. delete options;
  1641. }
  1642. template <typename Handler> void serialize(Handler &h, const int version)
  1643. {
  1644. h & options;
  1645. }
  1646. };
  1647. struct PregameGuiAction : public CPregamePackToPropagate
  1648. {
  1649. enum {NO_TAB, OPEN_OPTIONS, OPEN_SCENARIO_LIST};
  1650. ui8 action;
  1651. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1652. template <typename Handler> void serialize(Handler &h, const int version)
  1653. {
  1654. h & action;
  1655. }
  1656. };
  1657. struct RequestOptionsChange : public CPregamePackToHost
  1658. {
  1659. enum {TOWN, HERO, BONUS};
  1660. ui8 what;
  1661. si8 direction; //-1 or +1
  1662. ui8 playerID;
  1663. RequestOptionsChange(ui8 What, si8 Dir, ui8 Player)
  1664. :what(What), direction(Dir), playerID(Player)
  1665. {}
  1666. RequestOptionsChange(){}
  1667. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1668. template <typename Handler> void serialize(Handler &h, const int version)
  1669. {
  1670. h & what & direction & playerID;
  1671. }
  1672. };
  1673. struct PlayerLeft : public CPregamePackToPropagate
  1674. {
  1675. ui8 playerID;
  1676. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1677. template <typename Handler> void serialize(Handler &h, const int version)
  1678. {
  1679. h & playerID;
  1680. }
  1681. };
  1682. struct PlayersNames : public CPregamePackToPropagate
  1683. {
  1684. public:
  1685. std::map<ui32, std::string> playerNames;
  1686. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1687. template <typename Handler> void serialize(Handler &h, const int version)
  1688. {
  1689. h & playerNames;
  1690. }
  1691. };
  1692. struct StartWithCurrentSettings : public CPregamePackToPropagate
  1693. {
  1694. public:
  1695. void apply(CSelectionScreen *selScreen); //that functions are implemented in CPreGame.cpp
  1696. template <typename Handler> void serialize(Handler &h, const int version)
  1697. {
  1698. //h & playerNames;
  1699. }
  1700. };
  1701. #endif //__NETPACKS_H__