#include "StdInc.h" #include "CObjectClassesHandler.h" #include "../filesystem/Filesystem.h" #include "../filesystem/CBinaryReader.h" #include "../VCMI_Lib.h" #include "../GameConstants.h" #include "../StringConstants.h" #include "../CGeneralTextHandler.h" #include "CObjectHandler.h" #include "../CModHandler.h" #include "../JsonNode.h" #include "CRewardableConstructor.h" /* * ObjectTemplate.cpp, part of VCMI engine * * Authors: listed in file AUTHORS in main folder * * License: GNU General Public License v2.0 or later * Full text of license available in license.txt file, in main folder * */ static bool isOnVisitableFromTopList(int identifier, int type) { if(type == 2 || type == 3 || type == 4 || type == 5) //creature, hero, artifact, resource return true; static const Obj visitableFromTop[] = {Obj::FLOTSAM, Obj::SEA_CHEST, Obj::SHIPWRECK_SURVIVOR, Obj::BUOY, Obj::OCEAN_BOTTLE, Obj::BOAT, Obj::WHIRLPOOL, Obj::GARRISON, Obj::GARRISON2, Obj::SCHOLAR, Obj::CAMPFIRE, Obj::BORDERGUARD, Obj::BORDER_GATE, Obj::QUEST_GUARD, Obj::CORPSE }; if (vstd::find_pos(visitableFromTop, identifier) != -1) return true; return false; } ObjectTemplate::ObjectTemplate(): visitDir(8|16|32|64|128), // all but top id(Obj::NO_OBJ), subid(0), printPriority(0) { } void ObjectTemplate::readTxt(CLegacyConfigParser & parser) { std::string data = parser.readString(); std::vector strings; boost::split(strings, data, boost::is_any_of(" ")); assert(strings.size() == 9); animationFile = strings[0]; stringID = strings[0]; std::string & blockStr = strings[1]; //block map, 0 = blocked, 1 = unblocked std::string & visitStr = strings[2]; //visit map, 1 = visitable, 0 = not visitable assert(blockStr.size() == 6*8); assert(visitStr.size() == 6*8); setSize(8, 6); for (size_t i=0; i<6; i++) // 6 rows { for (size_t j=0; j<8; j++) // 8 columns { auto & tile = usedTiles[i][j]; tile |= VISIBLE; // assume that all tiles are visible if (blockStr[i*8 + j] == '0') tile |= BLOCKED; if (visitStr[i*8 + j] == '1') tile |= VISITABLE; } } // strings[3] most likely - terrains on which this object can be placed in editor. // e.g. Whirpool can be placed manually only on water while mines can be placed everywhere despite terrain-specific gfx // so these two fields can be interpreted as "strong affinity" and "weak affinity" towards terrains std::string & terrStr = strings[4]; // allowed terrains, 1 = object can be placed on this terrain assert(terrStr.size() == 9); // all terrains but rock for (size_t i=0; i<9; i++) { if (terrStr[8-i] == '1') allowedTerrains.insert(ETerrainType(i)); } id = Obj(boost::lexical_cast(strings[5])); subid = boost::lexical_cast(strings[6]); int type = boost::lexical_cast(strings[7]); printPriority = boost::lexical_cast(strings[8]) * 100; // to have some space in future if (isOnVisitableFromTopList(id, type)) visitDir = 0xff; else visitDir = (8|16|32|64|128); readMsk(); } void ObjectTemplate::readMsk() { ResourceID resID("SPRITES/" + animationFile, EResType::MASK); if (CResourceHandler::get()->existsResource(resID)) { auto msk = CResourceHandler::get()->load(resID)->readAll(); setSize(msk.first.get()[0], msk.first.get()[1]); } else //maximum possible size of H3 object //TODO: remove hardcode and move this data into modding system { setSize(8, 6); } } void ObjectTemplate::readMap(CBinaryReader & reader) { animationFile = reader.readString(); setSize(8, 6); ui8 blockMask[6]; ui8 visitMask[6]; for(auto & byte : blockMask) byte = reader.readUInt8(); for(auto & byte : visitMask) byte = reader.readUInt8(); for (size_t i=0; i<6; i++) // 6 rows { for (size_t j=0; j<8; j++) // 8 columns { auto & tile = usedTiles[5 - i][7 - j]; tile |= VISIBLE; // assume that all tiles are visible if (((blockMask[i] >> j) & 1 ) == 0) tile |= BLOCKED; if (((visitMask[i] >> j) & 1 ) != 0) tile |= VISITABLE; } } reader.readUInt16(); ui16 terrMask = reader.readUInt16(); for (size_t i=0; i<9; i++) { if (((terrMask >> i) & 1 ) != 0) allowedTerrains.insert(ETerrainType(i)); } id = Obj(reader.readUInt32()); subid = reader.readUInt32(); int type = reader.readUInt8(); printPriority = reader.readUInt8() * 100; // to have some space in future if (isOnVisitableFromTopList(id, type)) visitDir = 0xff; else visitDir = (8|16|32|64|128); reader.skip(16); readMsk(); if (id == Obj::EVENT) { setSize(1,1); usedTiles[0][0] = VISITABLE; } } void ObjectTemplate::readJson(const JsonNode &node, const bool withTerrain) { animationFile = node["animation"].String(); const JsonVector & visitDirs = node["visitableFrom"].Vector(); if (!visitDirs.empty()) { if (visitDirs[0].String()[0] == '+') visitDir |= 1; if (visitDirs[0].String()[1] == '+') visitDir |= 2; if (visitDirs[0].String()[2] == '+') visitDir |= 4; if (visitDirs[1].String()[2] == '+') visitDir |= 8; if (visitDirs[2].String()[2] == '+') visitDir |= 16; if (visitDirs[2].String()[1] == '+') visitDir |= 32; if (visitDirs[2].String()[0] == '+') visitDir |= 64; if (visitDirs[1].String()[0] == '+') visitDir |= 128; } else visitDir = 0x00; if(withTerrain && !node["allowedTerrains"].isNull()) { for (auto & entry : node["allowedTerrains"].Vector()) allowedTerrains.insert(ETerrainType(vstd::find_pos(GameConstants::TERRAIN_NAMES, entry.String()))); } else { for (size_t i=0; i< GameConstants::TERRAIN_TYPES; i++) allowedTerrains.insert(ETerrainType(i)); allowedTerrains.erase(ETerrainType::ROCK); } if(withTerrain && allowedTerrains.empty()) logGlobal->warnStream() << "Loaded template without allowed terrains!"; auto charToTile = [&](const char & ch) -> ui8 { switch (ch) { case ' ' : return 0; case '0' : return 0; case 'V' : return VISIBLE; case 'B' : return VISIBLE | BLOCKED; case 'H' : return BLOCKED; case 'A' : return VISIBLE | BLOCKED | VISITABLE; case 'T' : return BLOCKED | VISITABLE; default: logGlobal->errorStream() << "Unrecognized char " << ch << " in template mask"; return 0; } }; const JsonVector & mask = node["mask"].Vector(); size_t height = mask.size(); size_t width = 0; for (auto & line : mask) vstd::amax(width, line.String().size()); setSize(width, height); for (size_t i=0; i char { if(tile & VISIBLE) { if(tile & BLOCKED) { if(tile & VISITABLE) return 'A'; else return 'B'; } else return 'V'; } else { if(tile & BLOCKED) { if(tile & VISITABLE) return 'T'; else return 'H'; } else return '0'; } }; size_t height = getHeight(); size_t width = getWidth(); JsonVector & mask = node["mask"].Vector(); for(size_t i=0; i < height; i++) { JsonNode lineNode(JsonNode::DATA_STRING); std::string & line = lineNode.String(); line.resize(width); for(size_t j=0; j < width; j++) line[j] = tileToChar(usedTiles[height - 1 - i][width - 1 - j]); mask.push_back(lineNode); } if(printPriority != 0) node["zIndex"].Float() = printPriority; } ui32 ObjectTemplate::getWidth() const { //TODO: Use 2D array ui32 ret = 0; for (auto row : usedTiles) { ret = std::max(ret, row.size()); } return ret; } ui32 ObjectTemplate::getHeight() const { //TODO: Use 2D array return usedTiles.size(); } void ObjectTemplate::setSize(ui32 width, ui32 height) { usedTiles.resize(height); for (auto & line : usedTiles) line.resize(width, 0); } bool ObjectTemplate::isVisitable() const { for (auto & line : usedTiles) for (auto & tile : line) if (tile & VISITABLE) return true; return false; } bool ObjectTemplate::isWithin(si32 X, si32 Y) const { if (X < 0 || Y < 0) return false; if (X >= getWidth() || Y >= getHeight()) return false; return true; } bool ObjectTemplate::isVisitableAt(si32 X, si32 Y) const { if (isWithin(X, Y)) return usedTiles[Y][X] & VISITABLE; return false; } bool ObjectTemplate::isVisibleAt(si32 X, si32 Y) const { if (isWithin(X, Y)) return usedTiles[Y][X] & VISIBLE; return false; } bool ObjectTemplate::isBlockedAt(si32 X, si32 Y) const { if (isWithin(X, Y)) return usedTiles[Y][X] & BLOCKED; return false; } std::set ObjectTemplate::getBlockedOffsets() const { std::set ret; for(int w = 0; w < getWidth(); ++w) { for(int h = 0; h < getHeight(); ++h) { if (isBlockedAt(w, h)) ret.insert(int3(-w, -h, 0)); } } return ret; } int3 ObjectTemplate::getBlockMapOffset() const { for(int w = 0; w < getWidth(); ++w) { for(int h = 0; h < getHeight(); ++h) { if (isBlockedAt(w, h)) return int3(w, h, 0); } } return int3(0,0,0); } bool ObjectTemplate::isVisitableFrom(si8 X, si8 Y) const { // visitDir uses format // 1 2 3 // 8 4 // 7 6 5 int dirMap[3][3] = { { visitDir & 1, visitDir & 2, visitDir & 4 }, { visitDir & 128, 1 , visitDir & 8 }, { visitDir & 64, visitDir & 32, visitDir & 16 } }; // map input values to range 0..2 int dx = X < 0 ? 0 : X == 0 ? 1 : 2; int dy = Y < 0 ? 0 : Y == 0 ? 1 : 2; return dirMap[dy][dx] != 0; } int3 ObjectTemplate::getVisitableOffset() const { for(int y = 0; y < getHeight(); y++) for (int x = 0; x < getWidth(); x++) if (isVisitableAt(x, y)) return int3(x,y,0); //logGlobal->warnStream() << "Warning: getVisitableOffset called on non-visitable obj!"; return int3(0,0,0); } bool ObjectTemplate::isVisitableFromTop() const { return visitDir & 2; //for some reason the line below is never called :? //return isVisitableFrom (0, 1); } bool ObjectTemplate::canBePlacedAt(ETerrainType terrain) const { return allowedTerrains.count(terrain) != 0; }