2022-06-20 16:39:50 +02:00
|
|
|
/*
|
2023-01-09 01:17:37 +02:00
|
|
|
* TerrainHandler.h, part of VCMI engine
|
2022-06-20 16:39:50 +02:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
|
2022-12-20 16:14:06 +02:00
|
|
|
#include <vcmi/EntityService.h>
|
|
|
|
#include <vcmi/Entity.h>
|
2022-06-28 10:05:30 +02:00
|
|
|
#include "GameConstants.h"
|
2022-12-20 16:14:06 +02:00
|
|
|
#include "IHandlerBase.h"
|
2023-01-30 00:12:43 +02:00
|
|
|
#include "Color.h"
|
2023-08-23 14:07:50 +02:00
|
|
|
#include "filesystem/ResourcePath.h"
|
2022-06-20 16:39:50 +02:00
|
|
|
|
2022-07-26 15:07:42 +02:00
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
2022-06-22 10:41:02 +02:00
|
|
|
|
2023-07-05 21:07:20 +02:00
|
|
|
struct DLL_LINKAGE TerrainPaletteAnimation
|
|
|
|
{
|
|
|
|
/// index of first color to cycle
|
|
|
|
int32_t start;
|
|
|
|
/// total numbers of colors to cycle
|
|
|
|
int32_t length;
|
|
|
|
|
2024-01-20 20:34:51 +02:00
|
|
|
template <typename Handler> void serialize(Handler& h)
|
2023-07-05 21:07:20 +02:00
|
|
|
{
|
|
|
|
h & start;
|
|
|
|
h & length;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2022-12-20 16:14:06 +02:00
|
|
|
class DLL_LINKAGE TerrainType : public EntityT<TerrainId>
|
2022-06-20 16:39:50 +02:00
|
|
|
{
|
2023-01-01 17:10:47 +02:00
|
|
|
friend class TerrainTypeHandler;
|
|
|
|
std::string identifier;
|
2023-02-13 00:07:28 +02:00
|
|
|
std::string modScope;
|
2023-01-01 17:10:47 +02:00
|
|
|
TerrainId id;
|
|
|
|
ui8 passabilityType;
|
|
|
|
|
2023-06-07 18:51:44 +02:00
|
|
|
enum PassabilityType : ui8
|
|
|
|
{
|
2023-09-18 13:06:56 +02:00
|
|
|
//LAND = 1,
|
2023-06-07 18:51:44 +02:00
|
|
|
WATER = 2,
|
|
|
|
SURFACE = 4,
|
|
|
|
SUBTERRANEAN = 8,
|
|
|
|
ROCK = 16
|
|
|
|
};
|
|
|
|
|
2022-06-20 16:39:50 +02:00
|
|
|
public:
|
2022-12-20 18:35:40 +02:00
|
|
|
int32_t getIndex() const override { return id.getNum(); }
|
|
|
|
int32_t getIconIndex() const override { return 0; }
|
2023-02-13 00:07:28 +02:00
|
|
|
std::string getJsonKey() const override;
|
2022-12-20 18:35:40 +02:00
|
|
|
void registerIcons(const IconRegistar & cb) const override {}
|
|
|
|
TerrainId getId() const override { return id;}
|
2023-01-11 13:59:43 +02:00
|
|
|
void updateFrom(const JsonNode & data) {};
|
2022-12-20 16:14:06 +02:00
|
|
|
|
2023-01-18 23:56:01 +02:00
|
|
|
std::string getNameTextID() const override;
|
|
|
|
std::string getNameTranslated() const override;
|
2023-01-01 17:10:47 +02:00
|
|
|
|
2022-12-21 00:45:35 +02:00
|
|
|
std::vector<BattleField> battleFields;
|
2022-09-29 11:44:46 +02:00
|
|
|
std::vector<TerrainId> prohibitTransitions;
|
2023-01-30 00:12:43 +02:00
|
|
|
ColorRGBA minimapBlocked;
|
|
|
|
ColorRGBA minimapUnblocked;
|
2022-12-21 00:45:35 +02:00
|
|
|
std::string shortIdentifier;
|
2024-07-15 23:46:41 +02:00
|
|
|
std::vector<AudioPath> musicFilename;
|
2023-08-23 14:07:50 +02:00
|
|
|
AnimationPath tilesFilename;
|
2022-09-19 16:13:58 +02:00
|
|
|
std::string terrainViewPatterns;
|
2023-09-04 12:03:15 +02:00
|
|
|
AudioPath horseSound;
|
|
|
|
AudioPath horseSoundPenalty;
|
2022-09-19 16:13:58 +02:00
|
|
|
|
2023-07-05 21:07:20 +02:00
|
|
|
std::vector<TerrainPaletteAnimation> paletteAnimation;
|
|
|
|
|
2022-09-29 11:44:46 +02:00
|
|
|
TerrainId rockTerrain;
|
2022-12-21 00:45:35 +02:00
|
|
|
RiverId river;
|
2022-09-19 16:13:58 +02:00
|
|
|
int moveCost;
|
|
|
|
bool transitionRequired;
|
2023-03-13 23:26:44 +02:00
|
|
|
|
|
|
|
TerrainType() = default;
|
|
|
|
|
2022-06-20 16:39:50 +02:00
|
|
|
bool isLand() const;
|
|
|
|
bool isWater() const;
|
2023-10-04 13:11:13 +02:00
|
|
|
bool isRock() const;
|
|
|
|
|
2022-09-22 18:23:31 +02:00
|
|
|
bool isPassable() const;
|
2023-10-04 13:11:13 +02:00
|
|
|
|
2022-09-22 18:23:31 +02:00
|
|
|
bool isSurface() const;
|
2022-06-20 16:39:50 +02:00
|
|
|
bool isUnderground() const;
|
2022-06-22 10:41:02 +02:00
|
|
|
bool isTransitionRequired() const;
|
2022-06-20 16:39:50 +02:00
|
|
|
};
|
|
|
|
|
2022-12-20 16:14:06 +02:00
|
|
|
class DLL_LINKAGE TerrainTypeService : public EntityServiceT<TerrainId, TerrainType>
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
};
|
2022-09-19 16:13:58 +02:00
|
|
|
|
2022-12-20 16:14:06 +02:00
|
|
|
class DLL_LINKAGE TerrainTypeHandler : public CHandlerBase<TerrainId, TerrainType, TerrainType, TerrainTypeService>
|
|
|
|
{
|
|
|
|
public:
|
2024-05-17 00:05:51 +02:00
|
|
|
std::shared_ptr<TerrainType> loadFromJson(
|
2022-12-20 16:14:06 +02:00
|
|
|
const std::string & scope,
|
|
|
|
const JsonNode & json,
|
|
|
|
const std::string & identifier,
|
|
|
|
size_t index) override;
|
2022-09-19 16:13:58 +02:00
|
|
|
|
2024-02-13 16:21:30 +02:00
|
|
|
const std::vector<std::string> & getTypeNames() const override;
|
|
|
|
std::vector<JsonNode> loadLegacyData() override;
|
2022-12-20 16:14:06 +02:00
|
|
|
};
|
2022-09-21 11:34:23 +02:00
|
|
|
|
2022-07-26 15:07:42 +02:00
|
|
|
VCMI_LIB_NAMESPACE_END
|