2017-03-17 17:48:44 +02:00
/*
* BattleInfo . 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
2017-07-20 06:08:49 +02:00
# include "../int3.h"
2023-05-01 19:29:53 +02:00
# include "../bonuses/Bonus.h"
2023-04-30 16:35:15 +02:00
# include "../bonuses/CBonusSystemNode.h"
2017-06-28 23:09:35 +02:00
# include "CBattleInfoCallback.h"
2017-07-20 06:08:49 +02:00
# include "IBattleState.h"
# include "SiegeInfo.h"
# include "SideInBattle.h"
2017-03-17 17:48:44 +02:00
2022-07-26 15:07:42 +02:00
VCMI_LIB_NAMESPACE_BEGIN
2017-03-17 17:48:44 +02:00
class CStack ;
class CStackInstance ;
class CStackBasicDescriptor ;
2022-06-22 10:41:02 +02:00
class BattleField ;
2017-03-17 17:48:44 +02:00
2017-07-20 06:08:49 +02:00
class DLL_LINKAGE BattleInfo : public CBonusSystemNode , public CBattleInfoCallback , public IBattleState
2017-03-17 17:48:44 +02:00
{
2017-07-20 06:08:49 +02:00
public :
2023-08-25 17:23:15 +02:00
BattleID battleID = BattleID ( 0 ) ;
2021-02-03 19:19:56 +02:00
enum BattleSide
{
ATTACKER = 0 ,
DEFENDER
} ;
2017-03-17 17:48:44 +02:00
std : : array < SideInBattle , 2 > sides ; //sides[0] - attacker, sides[1] - defender
2017-07-20 06:08:49 +02:00
si32 round , activeStack ;
2017-03-17 17:48:44 +02:00
const CGTownInstance * town ; //used during town siege, nullptr if this is not a siege (note that fortless town IS also a siege)
int3 tile ; //for background and bonuses
2023-04-06 17:34:07 +02:00
bool creatureBank ; //auxilary field, do not serialize
2023-07-27 17:40:47 +02:00
bool replayAllowed ;
2017-03-17 17:48:44 +02:00
std : : vector < CStack * > stacks ;
std : : vector < std : : shared_ptr < CObstacleInstance > > obstacles ;
SiegeInfo si ;
2022-06-22 10:41:02 +02:00
BattleField battlefieldType ; //like !!BA:B
2022-09-29 11:44:46 +02:00
TerrainId terrainType ; //used for some stack nativity checks (not the bonus limiters though that have their own copy)
2017-03-17 17:48:44 +02:00
ui8 tacticsSide ; //which side is requested to play tactics phase
ui8 tacticDistance ; //how many hexes we can go forward (1 = only hexes adjacent to margin line)
template < typename Handler > void serialize ( Handler & h , const int version )
{
2023-08-25 17:23:15 +02:00
h & battleID ;
2017-03-17 17:48:44 +02:00
h & sides ;
2017-07-31 15:35:42 +02:00
h & round ;
h & activeStack ;
h & town ;
h & tile ;
h & stacks ;
h & obstacles ;
h & si ;
h & battlefieldType ;
h & terrainType ;
h & tacticsSide ;
h & tacticDistance ;
2017-03-17 17:48:44 +02:00
h & static_cast < CBonusSystemNode & > ( * this ) ;
2023-07-27 17:40:47 +02:00
if ( version > 824 )
h & replayAllowed ;
else
replayAllowed = false ;
2017-03-17 17:48:44 +02:00
}
//////////////////////////////////////////////////////////////////////////
BattleInfo ( ) ;
2017-07-20 06:08:49 +02:00
virtual ~ BattleInfo ( ) ;
//////////////////////////////////////////////////////////////////////////
// IBattleInfo
int32_t getActiveStackID ( ) const override ;
TStacks getStacksIf ( TStackFilter predicate ) const override ;
battle : : Units getUnitsIf ( battle : : UnitFilter predicate ) const override ;
2022-06-22 10:41:02 +02:00
BattleField getBattlefieldType ( ) const override ;
2022-09-29 11:44:46 +02:00
TerrainId getTerrainType ( ) const override ;
2017-07-20 06:08:49 +02:00
ObstacleCList getAllObstacles ( ) const override ;
PlayerColor getSidePlayer ( ui8 side ) const override ;
const CArmedInstance * getSideArmy ( ui8 side ) const override ;
const CGHeroInstance * getSideHero ( ui8 side ) const override ;
ui8 getTacticDist ( ) const override ;
ui8 getTacticsSide ( ) const override ;
const CGTownInstance * getDefendedTown ( ) const override ;
2023-01-13 00:35:58 +02:00
EWallState getWallState ( EWallPart partOfWall ) const override ;
2017-07-20 06:08:49 +02:00
EGateState getGateState ( ) const override ;
uint32_t getCastSpells ( ui8 side ) const override ;
int32_t getEnchanterCounter ( ui8 side ) const override ;
2023-04-05 02:26:29 +02:00
const IBonusBearer * getBonusBearer ( ) const override ;
2017-07-20 06:08:49 +02:00
uint32_t nextUnitId ( ) const override ;
2023-03-23 17:49:33 +02:00
int64_t getActualDamage ( const DamageRange & damage , int32_t attackerCount , vstd : : RNG & rng ) const override ;
2017-07-20 06:08:49 +02:00
//////////////////////////////////////////////////////////////////////////
// IBattleState
void nextRound ( int32_t roundNr ) override ;
void nextTurn ( uint32_t unitId ) override ;
void addUnit ( uint32_t id , const JsonNode & data ) override ;
void moveUnit ( uint32_t id , BattleHex destination ) override ;
void setUnitState ( uint32_t id , const JsonNode & data , int64_t healthDelta ) override ;
void removeUnit ( uint32_t id ) override ;
Entities redesign and a few ERM features
* Made most Handlers derived from CHandlerBase and moved service API there.
* Declared existing Entity APIs.
* Added basic script context caching
* Started Lua script module
* Started Lua spell effect API
* Started script state persistence
* Started battle info callback binding
* CommitPackage removed
* Extracted spells::Caster to own header; Expanded Spell API.
* implemented !!MC:S, !!FU:E, !!FU:P, !!MA, !!VR:H, !!VR:C
* !!BU:C, !!BU:E, !!BU:G, !!BU:M implemented
* Allow use of "MC:S@varName@" to declare normal variable (technically v-variable with string key)
* Re-enabled VERM macros.
* !?GM0 added
* !?TM implemented
* Added !!MF:N
* Started !?OB, !!BM, !!HE, !!OW, !!UN
* Added basic support of w-variables
* Added support for ERM indirect variables
* Made !?FU regular trigger
* !!re (ERA loop receiver) implemented
* Fixed ERM receivers with zero args.
2018-03-17 16:58:30 +02:00
void updateUnit ( uint32_t id , const JsonNode & data ) override ;
2017-07-20 06:08:49 +02:00
void addUnitBonus ( uint32_t id , const std : : vector < Bonus > & bonus ) override ;
void updateUnitBonus ( uint32_t id , const std : : vector < Bonus > & bonus ) override ;
void removeUnitBonus ( uint32_t id , const std : : vector < Bonus > & bonus ) override ;
2023-01-13 00:35:58 +02:00
void setWallState ( EWallPart partOfWall , EWallState state ) override ;
2017-07-20 06:08:49 +02:00
void addObstacle ( const ObstacleChanges & changes ) override ;
2020-02-12 19:12:12 +02:00
void updateObstacle ( const ObstacleChanges & changes ) override ;
2017-07-20 06:08:49 +02:00
void removeObstacle ( uint32_t id ) override ;
2023-02-15 00:44:59 +02:00
static void addOrUpdateUnitBonus ( CStack * sta , const Bonus & value , bool forceAdd ) ;
2017-03-17 17:48:44 +02:00
//////////////////////////////////////////////////////////////////////////
CStack * getStack ( int stackID , bool onlyAlive = true ) ;
using CBattleInfoEssentials : : battleGetArmyObject ;
CArmedInstance * battleGetArmyObject ( ui8 side ) const ;
using CBattleInfoEssentials : : battleGetFightingHero ;
CGHeroInstance * battleGetFightingHero ( ui8 side ) const ;
2023-08-25 17:23:15 +02:00
std : : pair < std : : vector < BattleHex > , int > getPath ( BattleHex start , BattleHex dest , const battle : : Unit * stack ) const ; //returned value: pair<path, length>; length may be different than number of elements in path since flying creatures jump between distant hexes
2017-03-17 17:48:44 +02:00
2017-06-26 18:50:35 +02:00
void calculateCasualties ( std : : map < ui32 , si32 > * casualties ) const ; //casualties are array of maps size 2 (attacker, defeneder), maps are (crid => amount)
2017-03-17 17:48:44 +02:00
2023-02-15 00:44:59 +02:00
CStack * generateNewStack ( uint32_t id , const CStackInstance & base , ui8 side , const SlotID & slot , BattleHex position ) ;
CStack * generateNewStack ( uint32_t id , const CStackBasicDescriptor & base , ui8 side , const SlotID & slot , BattleHex position ) ;
2017-03-17 17:48:44 +02:00
2023-02-15 00:44:59 +02:00
const CGHeroInstance * getHero ( const PlayerColor & player ) const ; //returns fighting hero that belongs to given player
2017-03-17 17:48:44 +02:00
void localInit ( ) ;
2022-09-29 11:44:46 +02:00
static BattleInfo * setupBattle ( const int3 & tile , TerrainId , const BattleField & battlefieldType , const CArmedInstance * armies [ 2 ] , const CGHeroInstance * heroes [ 2 ] , bool creatureBank , const CGTownInstance * town ) ;
2017-03-17 17:48:44 +02:00
2023-02-15 00:44:59 +02:00
ui8 whatSide ( const PlayerColor & player ) const ;
2017-03-17 17:48:44 +02:00
Entities redesign and a few ERM features
* Made most Handlers derived from CHandlerBase and moved service API there.
* Declared existing Entity APIs.
* Added basic script context caching
* Started Lua script module
* Started Lua spell effect API
* Started script state persistence
* Started battle info callback binding
* CommitPackage removed
* Extracted spells::Caster to own header; Expanded Spell API.
* implemented !!MC:S, !!FU:E, !!FU:P, !!MA, !!VR:H, !!VR:C
* !!BU:C, !!BU:E, !!BU:G, !!BU:M implemented
* Allow use of "MC:S@varName@" to declare normal variable (technically v-variable with string key)
* Re-enabled VERM macros.
* !?GM0 added
* !?TM implemented
* Added !!MF:N
* Started !?OB, !!BM, !!HE, !!OW, !!UN
* Added basic support of w-variables
* Added support for ERM indirect variables
* Made !?FU regular trigger
* !!re (ERA loop receiver) implemented
* Fixed ERM receivers with zero args.
2018-03-17 16:58:30 +02:00
protected :
2022-09-21 18:31:14 +02:00
# if SCRIPTING_ENABLED
Entities redesign and a few ERM features
* Made most Handlers derived from CHandlerBase and moved service API there.
* Declared existing Entity APIs.
* Added basic script context caching
* Started Lua script module
* Started Lua spell effect API
* Started script state persistence
* Started battle info callback binding
* CommitPackage removed
* Extracted spells::Caster to own header; Expanded Spell API.
* implemented !!MC:S, !!FU:E, !!FU:P, !!MA, !!VR:H, !!VR:C
* !!BU:C, !!BU:E, !!BU:G, !!BU:M implemented
* Allow use of "MC:S@varName@" to declare normal variable (technically v-variable with string key)
* Re-enabled VERM macros.
* !?GM0 added
* !?TM implemented
* Added !!MF:N
* Started !?OB, !!BM, !!HE, !!OW, !!UN
* Added basic support of w-variables
* Added support for ERM indirect variables
* Made !?FU regular trigger
* !!re (ERA loop receiver) implemented
* Fixed ERM receivers with zero args.
2018-03-17 16:58:30 +02:00
scripting : : Pool * getContextPool ( ) const override ;
2022-09-21 18:31:14 +02:00
# endif
2017-03-17 17:48:44 +02:00
} ;
class DLL_LINKAGE CMP_stack
{
int phase ; //rules of which phase will be used
int turn ;
2019-05-17 10:34:59 +02:00
uint8_t side ;
2017-03-17 17:48:44 +02:00
public :
2023-02-15 00:44:59 +02:00
bool operator ( ) ( const battle : : Unit * a , const battle : : Unit * b ) const ;
2019-05-17 10:34:59 +02:00
CMP_stack ( int Phase = 1 , int Turn = 0 , uint8_t Side = BattleSide : : ATTACKER ) ;
2017-03-17 17:48:44 +02:00
} ;
2022-07-26 15:07:42 +02:00
VCMI_LIB_NAMESPACE_END