2022-08-28 00:45:13 +02:00
|
|
|
/*
|
|
|
|
* 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 <vcmi/EntityService.h>
|
|
|
|
#include <vcmi/Entity.h>
|
|
|
|
#include "GameConstants.h"
|
|
|
|
#include "IHandlerBase.h"
|
|
|
|
#include "Terrain.h"
|
|
|
|
#include "battle/BattleHex.h"
|
|
|
|
|
|
|
|
struct DLL_LINKAGE ObstacleInfo : public EntityT<Obstacle>
|
|
|
|
{
|
2022-08-28 02:27:08 +02:00
|
|
|
ObstacleInfo(): obstacle(-1), width(0), height(0), isAbsoluteObstacle(false), iconIndex(0)
|
|
|
|
{}
|
|
|
|
|
|
|
|
ObstacleInfo(Obstacle obstacle, std::string identifier)
|
|
|
|
: obstacle(obstacle), identifier(identifier), iconIndex(obstacle.getNum()), name(identifier), width(0), height(0), isAbsoluteObstacle(false)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2022-08-28 00:45:13 +02:00
|
|
|
Obstacle obstacle;
|
|
|
|
si32 iconIndex;
|
|
|
|
std::string name;
|
|
|
|
std::string identifier;
|
|
|
|
std::string defName;
|
|
|
|
std::vector<Terrain> allowedTerrains;
|
|
|
|
std::vector<std::string> allowedSpecialBfields;
|
|
|
|
|
|
|
|
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<si16> blockedTiles; //offsets relative to obstacle position (that is its left bottom corner)
|
|
|
|
|
|
|
|
int32_t getIndex() const override;
|
|
|
|
int32_t getIconIndex() const override;
|
|
|
|
const std::string & getJsonKey() const override;
|
|
|
|
const std::string & getName() const override;
|
|
|
|
void registerIcons(const IconRegistar & cb) const override;
|
|
|
|
Obstacle getId() const override;
|
|
|
|
|
|
|
|
std::vector<BattleHex> getBlocked(BattleHex hex) const; //returns vector of hexes blocked by obstacle when it's placed on hex 'hex'
|
|
|
|
|
|
|
|
bool isAppropriate(const Terrain & terrainType, const BattleField & specialBattlefield) const;
|
|
|
|
|
|
|
|
template <typename Handler> void serialize(Handler &h, const int version)
|
|
|
|
{
|
2022-08-28 02:27:08 +02:00
|
|
|
h & obstacle;
|
|
|
|
h & iconIndex;
|
|
|
|
h & name;
|
|
|
|
h & identifier;
|
2022-08-28 00:45:13 +02:00
|
|
|
h & defName;
|
|
|
|
h & allowedTerrains;
|
|
|
|
h & allowedSpecialBfields;
|
|
|
|
h & isAbsoluteObstacle;
|
|
|
|
h & width;
|
|
|
|
h & height;
|
|
|
|
h & blockedTiles;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class DLL_LINKAGE ObstacleService : public EntityServiceT<Obstacle, ObstacleInfo>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
};
|
|
|
|
|
|
|
|
class ObstacleHandler: public CHandlerBase<Obstacle, ObstacleInfo, ObstacleInfo, ObstacleService>
|
|
|
|
{
|
|
|
|
public:
|
2022-08-28 02:27:08 +02:00
|
|
|
std::vector<Obstacle> absoluteObstacles;
|
|
|
|
std::vector<Obstacle> obstacles;
|
|
|
|
|
|
|
|
ObstacleInfo * loadFromJson(const std::string & scope,
|
|
|
|
const JsonNode & json,
|
|
|
|
const std::string & identifier,
|
|
|
|
size_t index) override;
|
2022-08-28 00:45:13 +02:00
|
|
|
|
2022-08-28 02:27:08 +02:00
|
|
|
const std::vector<std::string> & getTypeNames() const override;
|
|
|
|
std::vector<JsonNode> loadLegacyData(size_t dataSize) override;
|
|
|
|
std::vector<bool> getDefaultAllowed() const override;
|
2022-08-28 00:45:13 +02:00
|
|
|
|
|
|
|
template <typename Handler> void serialize(Handler & h, const int version)
|
|
|
|
{
|
|
|
|
h & objects;
|
|
|
|
}
|
|
|
|
};
|