1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-26 22:57:00 +02:00
vcmi/lib/battle/BattleAction.h
Ivan Savenko 2a05fbdd50 Unified handling of battle sides ID's
- Replaced BattleSide namespace-enum with enum class
- Merged two different BattleSide enum's into one
- Merged BattlePerspective enum into BattleSide enum
- Changed all places that use integers to represent battle side to use
BattleSide enum
- Added BattleSideArray convenience wrapper for std::array that is
always 2-elements in size and allows access to its elements using
BattleSide enum
2024-08-11 20:54:44 +00:00

86 lines
2.3 KiB
C++

/*
* BattleAction.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 "Destination.h"
#include "../GameConstants.h"
VCMI_LIB_NAMESPACE_BEGIN
class CBattleInfoCallback;
namespace battle
{
class Unit;
}
/// A struct which handles battle actions like defending, walking,... - represents a creature stack in a battle
class DLL_LINKAGE BattleAction
{
public:
BattleSide side; //who made this action
ui32 stackNumber; //stack ID, -1 left hero, -2 right hero,
EActionType actionType; //use ActionType enum for values
SpellID spell;
BattleAction();
static BattleAction makeHeal(const battle::Unit * healer, const battle::Unit * healed);
static BattleAction makeDefend(const battle::Unit * stack);
static BattleAction makeWait(const battle::Unit * stack);
static BattleAction makeMeleeAttack(const battle::Unit * stack, BattleHex destination, BattleHex attackFrom, bool returnAfterAttack = true);
static BattleAction makeShotAttack(const battle::Unit * shooter, const battle::Unit * target);
static BattleAction makeCreatureSpellcast(const battle::Unit * stack, const battle::Target & target, const SpellID & spellID);
static BattleAction makeMove(const battle::Unit * stack, BattleHex dest);
static BattleAction makeEndOFTacticPhase(BattleSide side);
static BattleAction makeRetreat(BattleSide side);
static BattleAction makeSurrender(BattleSide side);
bool isTacticsAction() const;
bool isUnitAction() const;
bool isSpellAction() const;
bool isBattleEndAction() const;
std::string toString() const;
void aimToHex(const BattleHex & destination);
void aimToUnit(const battle::Unit * destination);
battle::Target getTarget(const CBattleInfoCallback * cb) const;
void setTarget(const battle::Target & target_);
template <typename Handler> void serialize(Handler & h)
{
h & side;
h & stackNumber;
h & actionType;
h & spell;
h & target;
}
private:
struct DestinationInfo
{
int32_t unitValue;
BattleHex hexValue;
template <typename Handler> void serialize(Handler & h)
{
h & unitValue;
h & hexValue;
}
};
std::vector<DestinationInfo> target;
};
DLL_EXPORT std::ostream & operator<<(std::ostream & os, const BattleAction & ba); //todo: remove
VCMI_LIB_NAMESPACE_END