1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-22 22:13:35 +02:00
vcmi/lib/battle/CObstacleInstance.h
Ivan Savenko 0c07384293 Refactoring of serialization versioning handling
- Removed 'version' field from serialize() method
- Handler classes - Binary(De)Serializer now have 'version' field
- Serialization versioning now uses named enum

Save compatibility with 1.4.X saves should be intact
2024-01-20 20:34:51 +02:00

141 lines
3.9 KiB
C++

/*
* CObstacleInstance.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 "BattleHex.h"
#include "../filesystem/ResourcePath.h"
#include "../networkPacks/BattleChanges.h"
#include "../constants/EntityIdentifiers.h"
VCMI_LIB_NAMESPACE_BEGIN
class ObstacleInfo;
class ObstacleChanges;
class JsonSerializeFormat;
class SpellID;
struct DLL_LINKAGE CObstacleInstance
{
enum EObstacleType : ui8
{
//ABSOLUTE needs an underscore because it's a Win
USUAL, ABSOLUTE_OBSTACLE, SPELL_CREATED, MOAT
};
BattleHex pos; //position on battlefield, typically left bottom corner
EObstacleType obstacleType = USUAL;
si32 uniqueID = -1;
si32 ID = -1; //ID of obstacle (defines type of it)
virtual ~CObstacleInstance() = default;
const ObstacleInfo &getInfo() const; //allowed only when not generated by spell (usual or absolute)
std::vector<BattleHex> getBlockedTiles() const;
std::vector<BattleHex> getStoppingTile() const; //hexes that will stop stack move
//The two functions below describe how the obstacle affects affected tiles
//additional effects (like hurting stack or disappearing) are hardcoded for appropriate obstacleTypes
virtual bool blocksTiles() const;
virtual bool stopsMovement() const; //if unit stepping onto obstacle, can't continue movement (in general, doesn't checks for the side)
virtual bool triggersEffects() const;
virtual SpellID getTrigger() const;
virtual std::vector<BattleHex> getAffectedTiles() const;
virtual bool visibleForSide(ui8 side, bool hasNativeStack) const; //0 attacker
virtual void battleTurnPassed(){};
//Client helper functions, make it easier to render animations
virtual const AnimationPath & getAnimation() const;
virtual const AnimationPath & getAppearAnimation() const;
virtual const AudioPath & getAppearSound() const;
virtual int getAnimationYOffset(int imageHeight) const;
void toInfo(ObstacleChanges & info, BattleChanges::EOperation operation = BattleChanges::EOperation::ADD);
virtual void serializeJson(JsonSerializeFormat & handler);
template <typename Handler> void serialize(Handler &h)
{
h & ID;
h & pos;
h & obstacleType;
h & uniqueID;
}
};
struct DLL_LINKAGE SpellCreatedObstacle : CObstacleInstance
{
int32_t turnsRemaining;
int32_t casterSpellPower;
int32_t spellLevel;
int32_t minimalDamage; //How many damage should it do regardless of power and level of caster
si8 casterSide; //0 - obstacle created by attacker; 1 - by defender
SpellID trigger;
bool hidden;
bool passable;
bool trap;
bool removeOnTrigger;
bool revealed;
bool nativeVisible; //Should native terrain creatures reveal obstacle
AudioPath appearSound;
AnimationPath appearAnimation;
AnimationPath animation;
int animationYOffset;
std::vector<BattleHex> customSize;
SpellCreatedObstacle();
std::vector<BattleHex> getAffectedTiles() const override;
bool visibleForSide(ui8 side, bool hasNativeStack) const override;
bool blocksTiles() const override;
bool stopsMovement() const override;
SpellID getTrigger() const override;
void battleTurnPassed() override;
//Client helper functions, make it easier to render animations
const AnimationPath & getAnimation() const override;
const AnimationPath & getAppearAnimation() const override;
const AudioPath & getAppearSound() const override;
int getAnimationYOffset(int imageHeight) const override;
void fromInfo(const ObstacleChanges & info);
void serializeJson(JsonSerializeFormat & handler) override;
template <typename Handler> void serialize(Handler &h)
{
h & static_cast<CObstacleInstance&>(*this);
h & turnsRemaining;
h & casterSpellPower;
h & spellLevel;
h & casterSide;
h & hidden;
h & nativeVisible;
h & passable;
h & trigger;
h & minimalDamage;
h & trap;
h & customSize;
}
};
VCMI_LIB_NAMESPACE_END