CDefObjInfoHandler.cpp 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  1. #include "StdInc.h"
  2. #include "CDefObjInfoHandler.h"
  3. #include "filesystem/Filesystem.h"
  4. #include "filesystem/CBinaryReader.h"
  5. //#include "../client/CGameInfo.h"
  6. #include "../lib/VCMI_Lib.h"
  7. #include "GameConstants.h"
  8. #include "StringConstants.h"
  9. #include "CGeneralTextHandler.h"
  10. #include "CModHandler.h"
  11. #include "JsonNode.h"
  12. /*
  13. * CDefObjInfoHandler.cpp, part of VCMI engine
  14. *
  15. * Authors: listed in file AUTHORS in main folder
  16. *
  17. * License: GNU General Public License v2.0 or later
  18. * Full text of license available in license.txt file, in main folder
  19. *
  20. */
  21. static bool isVisitableFromTop(int identifier, int type)
  22. {
  23. if(type == 2 || type == 3 || type == 4 || type == 5) //creature, hero, artifact, resource
  24. return true;
  25. static const Obj visitableFromTop[] =
  26. {Obj::FLOTSAM,
  27. Obj::SEA_CHEST,
  28. Obj::SHIPWRECK_SURVIVOR,
  29. Obj::BUOY,
  30. Obj::OCEAN_BOTTLE,
  31. Obj::BOAT,
  32. Obj::WHIRLPOOL,
  33. Obj::GARRISON,
  34. Obj::GARRISON2,
  35. Obj::SCHOLAR,
  36. Obj::CAMPFIRE,
  37. Obj::BORDERGUARD,
  38. Obj::BORDER_GATE,
  39. Obj::QUEST_GUARD,
  40. Obj::CORPSE
  41. };
  42. if (vstd::find_pos(visitableFromTop, identifier) != -1)
  43. return true;
  44. return false;
  45. }
  46. ObjectTemplate::ObjectTemplate():
  47. visitDir(8|16|32|64|128), // all but top
  48. id(Obj::NO_OBJ),
  49. subid(0),
  50. printPriority(0)
  51. {
  52. }
  53. void ObjectTemplate::readTxt(CLegacyConfigParser & parser)
  54. {
  55. std::string data = parser.readString();
  56. std::vector<std::string> strings;
  57. boost::split(strings, data, boost::is_any_of(" "));
  58. assert(strings.size() == 9);
  59. animationFile = strings[0];
  60. std::string & blockStr = strings[1]; //block map, 0 = blocked, 1 = unblocked
  61. std::string & visitStr = strings[2]; //visit map, 1 = visitable, 0 = not visitable
  62. assert(blockStr.size() == 6*8);
  63. assert(visitStr.size() == 6*8);
  64. setSize(8, 6);
  65. for (size_t i=0; i<6; i++) // 6 rows
  66. {
  67. for (size_t j=0; j<8; j++) // 8 columns
  68. {
  69. auto & tile = usedTiles[i][j];
  70. tile |= VISIBLE; // assume that all tiles are visible
  71. if (blockStr[i*8 + j] == '0')
  72. tile |= BLOCKED;
  73. if (visitStr[i*8 + j] == '1')
  74. tile |= VISITABLE;
  75. }
  76. }
  77. // strings[3] most likely - terrains on which this object can be placed in editor.
  78. // e.g. Whirpool can be placed manually only on water while mines can be placed everywhere despite terrain-specific gfx
  79. // so these two fields can be interpreted as "strong affinity" and "weak affinity" towards terrains
  80. std::string & terrStr = strings[4]; // allowed terrains, 1 = object can be placed on this terrain
  81. assert(terrStr.size() == 9); // all terrains but rock
  82. for (size_t i=0; i<9; i++)
  83. {
  84. if (terrStr[8-i] == '1')
  85. allowedTerrains.insert(ETerrainType(i));
  86. }
  87. id = Obj(boost::lexical_cast<int>(strings[5]));
  88. subid = boost::lexical_cast<int>(strings[6]);
  89. int type = boost::lexical_cast<int>(strings[7]);
  90. printPriority = boost::lexical_cast<int>(strings[8]) * 100; // to have some space in future
  91. if (isVisitableFromTop(id, type))
  92. visitDir = 0xff;
  93. else
  94. visitDir = (8|16|32|64|128);
  95. readMsk();
  96. }
  97. void ObjectTemplate::readMsk()
  98. {
  99. ResourceID resID("SPRITES/" + animationFile, EResType::MASK);
  100. if (CResourceHandler::get()->existsResource(resID))
  101. {
  102. auto msk = CResourceHandler::get()->load(resID)->readAll();
  103. setSize(msk.first.get()[0], msk.first.get()[1]);
  104. }
  105. else //maximum possible size of H3 object //TODO: remove hardcode and move this data into modding system
  106. {
  107. setSize(8, 6);
  108. }
  109. }
  110. void ObjectTemplate::readMap(CBinaryReader & reader)
  111. {
  112. animationFile = reader.readString();
  113. setSize(8, 6);
  114. ui8 blockMask[6];
  115. ui8 visitMask[6];
  116. for(auto & byte : blockMask)
  117. byte = reader.readUInt8();
  118. for(auto & byte : visitMask)
  119. byte = reader.readUInt8();
  120. for (size_t i=0; i<6; i++) // 6 rows
  121. {
  122. for (size_t j=0; j<8; j++) // 8 columns
  123. {
  124. auto & tile = usedTiles[5 - i][7 - j];
  125. tile |= VISIBLE; // assume that all tiles are visible
  126. if (((blockMask[i] >> j) & 1 ) == 0)
  127. tile |= BLOCKED;
  128. if (((visitMask[i] >> j) & 1 ) != 0)
  129. tile |= VISITABLE;
  130. }
  131. }
  132. reader.readUInt16();
  133. ui16 terrMask = reader.readUInt16();
  134. for (size_t i=0; i<9; i++)
  135. {
  136. if (((terrMask >> i) & 1 ) != 0)
  137. allowedTerrains.insert(ETerrainType(i));
  138. }
  139. id = Obj(reader.readUInt32());
  140. subid = reader.readUInt32();
  141. int type = reader.readUInt8();
  142. printPriority = reader.readUInt8() * 100; // to have some space in future
  143. if (isVisitableFromTop(id, type))
  144. visitDir = 0xff;
  145. else
  146. visitDir = (8|16|32|64|128);
  147. reader.skip(16);
  148. readMsk();
  149. if (id == Obj::EVENT)
  150. {
  151. setSize(1,1);
  152. usedTiles[0][0] = VISITABLE;
  153. }
  154. }
  155. void ObjectTemplate::readJson(const JsonNode &node)
  156. {
  157. id = Obj(node["basebase"].Float()); // temporary, should be replaced
  158. subid = node["base"].Float();
  159. animationFile = node["animation"].String();
  160. const JsonVector & visitDirs = node["visitableFrom"].Vector();
  161. if (!visitDirs.empty())
  162. {
  163. if (visitDirs[0].String()[0] == '+') visitDir |= 1;
  164. if (visitDirs[0].String()[1] == '+') visitDir |= 2;
  165. if (visitDirs[0].String()[2] == '+') visitDir |= 4;
  166. if (visitDirs[1].String()[2] == '+') visitDir |= 8;
  167. if (visitDirs[2].String()[2] == '+') visitDir |= 16;
  168. if (visitDirs[2].String()[1] == '+') visitDir |= 32;
  169. if (visitDirs[2].String()[0] == '+') visitDir |= 64;
  170. if (visitDirs[1].String()[0] == '+') visitDir |= 128;
  171. }
  172. else
  173. visitDir = 0xff;
  174. for (auto & entry : node["allowedTerrains"].Vector())
  175. allowedTerrains.insert(ETerrainType(vstd::find_pos(GameConstants::TERRAIN_NAMES, entry.String())));
  176. auto charToTile = [&](const char & ch) -> ui8
  177. {
  178. switch (ch)
  179. {
  180. case '0' : return 0;
  181. case 'V' : return VISIBLE;
  182. case 'B' : return VISIBLE | BLOCKED;
  183. case 'H' : return BLOCKED;
  184. case 'A' : return VISIBLE | BLOCKED | VISITABLE;
  185. case 'T' : return VISIBLE | VISITABLE;
  186. default:
  187. logGlobal->errorStream() << "Unrecognized char " << ch << " in template mask";
  188. return 0;
  189. }
  190. };
  191. size_t maxHeight = 0, maxWidth = 0;
  192. size_t width = node["mask"].Vector()[0].String().size();
  193. size_t height = node["mask"].Vector().size();
  194. setSize(width, height);
  195. for (size_t i=0; i<height; i++)
  196. {
  197. const std::string & line = node["mask"].Vector()[i].String();
  198. assert(line.size() == width);
  199. for (size_t j=0; j < width; j++)
  200. {
  201. ui8 tile = charToTile(line[j]);
  202. if (tile != 0)
  203. {
  204. vstd::amax(maxHeight, i);
  205. vstd::amax(maxWidth, j);
  206. usedTiles[i][j] = tile;
  207. }
  208. }
  209. }
  210. setSize(maxWidth, maxHeight);
  211. printPriority = node["zIndex"].Float();
  212. }
  213. ui32 ObjectTemplate::getWidth() const
  214. {
  215. return usedTiles.empty() ? 0 : usedTiles.front().size();
  216. }
  217. ui32 ObjectTemplate::getHeight() const
  218. {
  219. return usedTiles.size();
  220. }
  221. void ObjectTemplate::setSize(ui32 width, ui32 height)
  222. {
  223. usedTiles.resize(height);
  224. for (auto & line : usedTiles)
  225. line.resize(width);
  226. }
  227. bool ObjectTemplate::isVisitable() const
  228. {
  229. for (auto & line : usedTiles)
  230. for (auto & tile : line)
  231. if (tile & VISITABLE)
  232. return true;
  233. return false;
  234. }
  235. bool ObjectTemplate::isWithin(si32 X, si32 Y) const
  236. {
  237. if (X < 0 || Y < 0)
  238. return false;
  239. if (X >= getWidth() || Y >= getHeight())
  240. return false;
  241. return true;
  242. }
  243. bool ObjectTemplate::isVisitableAt(si32 X, si32 Y) const
  244. {
  245. if (isWithin(X, Y))
  246. return usedTiles[Y][X] & VISITABLE;
  247. return false;
  248. }
  249. bool ObjectTemplate::isVisibleAt(si32 X, si32 Y) const
  250. {
  251. if (isWithin(X, Y))
  252. return usedTiles[Y][X] & VISIBLE;
  253. return false;
  254. }
  255. bool ObjectTemplate::isBlockedAt(si32 X, si32 Y) const
  256. {
  257. if (isWithin(X, Y))
  258. return usedTiles[Y][X] & BLOCKED;
  259. return false;
  260. }
  261. bool ObjectTemplate::isVisitableFrom(si8 X, si8 Y) const
  262. {
  263. // visitDir uses format
  264. // 1 2 3
  265. // 8 4
  266. // 7 6 5
  267. int dirMap[3][3] =
  268. {
  269. { visitDir & 1, visitDir & 2, visitDir & 4 },
  270. { visitDir & 128, 1 , visitDir & 8 },
  271. { visitDir & 64, visitDir & 32, visitDir & 16 }
  272. };
  273. // map input values to range 0..2
  274. int dx = X < 0 ? 0 : X == 0 ? 1 : 2;
  275. int dy = Y < 0 ? 0 : Y == 0 ? 1 : 2;
  276. return dirMap[dy][dx] != 0;
  277. }
  278. bool ObjectTemplate::canBePlacedAt(ETerrainType terrain) const
  279. {
  280. return allowedTerrains.count(terrain) != 0;
  281. }
  282. void CDefObjInfoHandler::readTextFile(std::string path)
  283. {
  284. CLegacyConfigParser parser(path);
  285. size_t totalNumber = parser.readNumber(); // first line contains number of objects to read and nothing else
  286. parser.endLine();
  287. for (size_t i=0; i<totalNumber; i++)
  288. {
  289. ObjectTemplate templ;
  290. templ.readTxt(parser);
  291. parser.endLine();
  292. objects.push_back(templ);
  293. }
  294. }
  295. CDefObjInfoHandler::CDefObjInfoHandler()
  296. {
  297. readTextFile("Data/Objects.txt");
  298. readTextFile("Data/Heroes.txt");
  299. const JsonNode node = JsonUtils::assembleFromFiles("config/objectTemplates.json");
  300. std::vector<ObjectTemplate> newTemplates;
  301. newTemplates.reserve(node.Struct().size());
  302. // load all new templates
  303. for (auto & entry : node.Struct())
  304. {
  305. ObjectTemplate templ;
  306. templ.readJson(entry.second);
  307. newTemplates.push_back(templ);
  308. }
  309. // erase old ones to avoid conflicts
  310. for (auto & entry : newTemplates)
  311. eraseAll(entry.id, entry.subid);
  312. // merge new templates into storage
  313. objects.insert(objects.end(), newTemplates.begin(), newTemplates.end());
  314. }
  315. void CDefObjInfoHandler::eraseAll(Obj type, si32 subtype)
  316. {
  317. auto it = std::remove_if(objects.begin(), objects.end(), [&](const ObjectTemplate & obj)
  318. {
  319. return obj.id == type && obj.subid == subtype;
  320. });
  321. objects.erase(it, objects.end());
  322. }
  323. void CDefObjInfoHandler::registerTemplate(ObjectTemplate obj)
  324. {
  325. objects.push_back(obj);
  326. }
  327. std::vector<ObjectTemplate> CDefObjInfoHandler::pickCandidates(Obj type, si32 subtype) const
  328. {
  329. std::vector<ObjectTemplate> ret;
  330. std::copy_if(objects.begin(), objects.end(), std::back_inserter(ret), [&](const ObjectTemplate & obj)
  331. {
  332. return obj.id == type && obj.subid == subtype;
  333. });
  334. if (ret.empty())
  335. logGlobal->errorStream() << "Failed to find template for " << type << ":" << subtype;
  336. assert(!ret.empty()); // Can't create object of this type/subtype
  337. return ret;
  338. }
  339. std::vector<ObjectTemplate> CDefObjInfoHandler::pickCandidates(Obj type, si32 subtype, ETerrainType terrain) const
  340. {
  341. std::vector<ObjectTemplate> ret = pickCandidates(type, subtype);
  342. std::vector<ObjectTemplate> filtered;
  343. std::copy_if(ret.begin(), ret.end(), std::back_inserter(filtered), [&](const ObjectTemplate & obj)
  344. {
  345. return obj.canBePlacedAt(terrain);
  346. });
  347. // it is possible that there are no templates usable on specific terrain. In this case - return list before filtering
  348. return filtered.empty() ? ret : filtered;
  349. }