/* * ObstacleHandler.h, 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 * */ #pragma once #include #include #include "GameConstants.h" #include "IHandlerBase.h" #include "battle/BattleHex.h" VCMI_LIB_NAMESPACE_BEGIN class DLL_LINKAGE ObstacleInfo : public EntityT { public: ObstacleInfo(): obstacle(-1), width(0), height(0), isAbsoluteObstacle(false), iconIndex(0) {} ObstacleInfo(Obstacle obstacle, std::string identifier) : obstacle(obstacle), identifier(identifier), iconIndex(obstacle.getNum()), width(0), height(0), isAbsoluteObstacle(false) { } Obstacle obstacle; si32 iconIndex; std::string identifier; std::string appearSound, appearAnimation, triggerAnimation, triggerSound, animation; std::vector allowedTerrains; std::vector allowedSpecialBfields; //TODO: here is extra field to implement it's logic in the future but save backward compatibility int obstacleType = -1; ui8 isAbsoluteObstacle; //there may only one such obstacle in battle and its position is always the same si32 width, height; //how much space to the right and up is needed to place obstacle (affects only placement algorithm) std::vector blockedTiles; //offsets relative to obstacle position (that is its left bottom corner) int32_t getIndex() const override; int32_t getIconIndex() const override; std::string getJsonKey() const override; std::string getNameTranslated() const override; std::string getNameTextID() const override; void registerIcons(const IconRegistar & cb) const override; Obstacle getId() const override; std::vector getBlocked(BattleHex hex) const; //returns vector of hexes blocked by obstacle when it's placed on hex 'hex' bool isAppropriate(const TerrainId terrainType, const BattleField & specialBattlefield) const; template void serialize(Handler &h, const int version) { h & obstacle; h & obstacleType; h & iconIndex; h & identifier; h & animation; h & appearAnimation; h & triggerAnimation; if (version > 806) { h & appearSound; h & triggerSound; } h & allowedTerrains; h & allowedSpecialBfields; h & isAbsoluteObstacle; h & width; h & height; h & blockedTiles; } }; class DLL_LINKAGE ObstacleService : public EntityServiceT { public: }; class ObstacleHandler: public CHandlerBase { public: ObstacleInfo * loadFromJson(const std::string & scope, const JsonNode & json, const std::string & identifier, size_t index) override; const std::vector & getTypeNames() const override; std::vector loadLegacyData() override; std::vector getDefaultAllowed() const override; template void serialize(Handler & h, const int version) { h & objects; } }; VCMI_LIB_NAMESPACE_END