mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-26 22:57:00 +02:00
119 lines
3.4 KiB
C++
119 lines
3.4 KiB
C++
/*
|
|
* BattleHex.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
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
//TODO: change to enum class
|
|
|
|
namespace BattleSide
|
|
{
|
|
enum Type
|
|
{
|
|
ATTACKER = 0,
|
|
DEFENDER = 1
|
|
};
|
|
}
|
|
|
|
namespace GameConstants
|
|
{
|
|
const int BFIELD_WIDTH = 17;
|
|
const int BFIELD_HEIGHT = 11;
|
|
const int BFIELD_SIZE = BFIELD_WIDTH * BFIELD_HEIGHT;
|
|
}
|
|
|
|
using BattleSideOpt = boost::optional<ui8>;
|
|
|
|
// for battle stacks' positions
|
|
struct DLL_LINKAGE BattleHex //TODO: decide if this should be changed to class for better code design
|
|
{
|
|
// helpers for siege
|
|
static constexpr si16 CASTLE_CENTRAL_TOWER = -2;
|
|
static constexpr si16 CASTLE_BOTTOM_TOWER = -3;
|
|
static constexpr si16 CASTLE_UPPER_TOWER = -4;
|
|
|
|
// hexes for interaction with heroes
|
|
static constexpr si16 HERO_ATTACKER = 0;
|
|
static constexpr si16 HERO_DEFENDER = GameConstants::BFIELD_WIDTH - 1;
|
|
|
|
// helpers for rendering
|
|
static constexpr si16 HEX_BEFORE_ALL = std::numeric_limits<si16>::min();
|
|
static constexpr si16 HEX_AFTER_ALL = std::numeric_limits<si16>::max();
|
|
|
|
si16 hex;
|
|
static constexpr si16 INVALID = -1;
|
|
enum EDir
|
|
{
|
|
NONE = -1,
|
|
|
|
TOP_LEFT,
|
|
TOP_RIGHT,
|
|
RIGHT,
|
|
BOTTOM_RIGHT,
|
|
BOTTOM_LEFT,
|
|
LEFT,
|
|
|
|
//Note: unused by BattleHex class, used by other code
|
|
TOP,
|
|
BOTTOM
|
|
};
|
|
|
|
BattleHex();
|
|
BattleHex(si16 _hex);
|
|
BattleHex(si16 x, si16 y);
|
|
BattleHex(std::pair<si16, si16> xy);
|
|
operator si16() const;
|
|
bool isValid() const;
|
|
bool isAvailable() const; //valid position not in first or last column
|
|
void setX(si16 x);
|
|
void setY(si16 y);
|
|
void setXY(si16 x, si16 y, bool hasToBeValid = true);
|
|
void setXY(std::pair<si16, si16> xy);
|
|
si16 getX() const;
|
|
si16 getY() const;
|
|
std::pair<si16, si16> getXY() const;
|
|
BattleHex& moveInDirection(EDir dir, bool hasToBeValid = true);
|
|
BattleHex& operator+=(EDir dir);
|
|
BattleHex cloneInDirection(EDir dir, bool hasToBeValid = true) const;
|
|
BattleHex operator+(EDir dir) const;
|
|
|
|
/// returns all valid neighbouring tiles
|
|
std::vector<BattleHex> neighbouringTiles() const;
|
|
|
|
/// returns all tiles, unavailable tiles will be set as invalid
|
|
/// order of returned tiles matches EDir enim
|
|
std::vector<BattleHex> allNeighbouringTiles() const;
|
|
|
|
static EDir mutualPosition(BattleHex hex1, BattleHex hex2);
|
|
static uint8_t getDistance(BattleHex hex1, BattleHex hex2);
|
|
static void checkAndPush(BattleHex tile, std::vector<BattleHex> & ret);
|
|
static BattleHex getClosestTile(ui8 side, BattleHex initialPos, std::set<BattleHex> & possibilities); //TODO: vector or set? copying one to another is bad
|
|
|
|
template <typename Handler>
|
|
void serialize(Handler &h, const int version)
|
|
{
|
|
h & hex;
|
|
}
|
|
|
|
using NeighbouringTiles = std::array<BattleHex, 6>;
|
|
using NeighbouringTilesCache = std::vector<NeighbouringTiles>;
|
|
|
|
static const NeighbouringTilesCache neighbouringTilesCache;
|
|
private:
|
|
//Constexpr defined array with all directions used in battle
|
|
static constexpr auto hexagonalDirections() {
|
|
return std::array<EDir,6>{BattleHex::TOP_LEFT, BattleHex::TOP_RIGHT, BattleHex::RIGHT, BattleHex::BOTTOM_RIGHT, BattleHex::BOTTOM_LEFT, BattleHex::LEFT};
|
|
}
|
|
};
|
|
|
|
DLL_EXPORT std::ostream & operator<<(std::ostream & os, const BattleHex & hex);
|
|
|
|
VCMI_LIB_NAMESPACE_END
|