2014-04-19 20:44:21 +03:00
/*
2014-04-20 11:58:58 +03:00
* CGameInfoCallback . h , part of VCMI engine
2014-04-19 20:44:21 +03: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
*
*/
2017-07-13 10:26:03 +02:00
# pragma once
2017-07-20 06:08:49 +02:00
# include "int3.h"
2017-07-13 10:26:03 +02:00
# include "ResourceSet.h" // for Res::ERes
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
# include "battle/CCallbackBase.h"
2022-07-26 15:07:42 +02:00
VCMI_LIB_NAMESPACE_BEGIN
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
class Player ;
class Team ;
2014-04-19 20:44:21 +03:00
struct InfoWindow ;
struct PlayerSettings ;
struct CPackForClient ;
struct TerrainTile ;
struct PlayerState ;
class CTown ;
struct StartInfo ;
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
struct InfoAboutHero ;
2014-04-19 20:44:21 +03:00
struct InfoAboutTown ;
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
2014-04-19 20:44:21 +03:00
struct UpgradeInfo ;
struct SThievesGuildInfo ;
class CMapHeader ;
struct TeamState ;
struct QuestInfo ;
2017-09-13 02:35:58 +02:00
struct ShashInt3 ;
2017-07-20 06:08:49 +02:00
class CGameState ;
2018-10-07 13:51:27 +02:00
class PathfinderConfig ;
2014-04-20 10:13:37 +03: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
class CArmedInstance ;
class CGObjectInstance ;
class CGHeroInstance ;
class CGDwelling ;
class CGTeleport ;
class CGTownInstance ;
class DLL_LINKAGE IGameInfoCallback
{
public :
//TODO: all other public methods of CGameInfoCallback
// //various
virtual int getDate ( Date : : EDateType mode = Date : : DAY ) const = 0 ; //mode=0 - total days in game, mode=1 - day of week, mode=2 - current week, mode=3 - current month
// const StartInfo * getStartInfo(bool beforeRandomization = false)const;
virtual bool isAllowed ( int32_t type , int32_t id ) const = 0 ; //type: 0 - spell; 1- artifact; 2 - secondary skill
//player
virtual const Player * getPlayer ( PlayerColor color ) const = 0 ;
// virtual int getResource(PlayerColor Player, Res::ERes which) const = 0;
// bool isVisible(int3 pos) const;
// PlayerRelations::PlayerRelations getPlayerRelations(PlayerColor color1, PlayerColor color2) const;
// void getThievesGuildInfo(SThievesGuildInfo & thi, const CGObjectInstance * obj); //get thieves' guild info obtainable while visiting given object
// EPlayerStatus::EStatus getPlayerStatus(PlayerColor player, bool verbose = true) const; //-1 if no such player
// PlayerColor getCurrentPlayer() const; //player that currently makes move // TODO synchronous turns
virtual PlayerColor getLocalPlayer ( ) const = 0 ; //player that is currently owning given client (if not a client, then returns current player)
// const PlayerSettings * getPlayerSettings(PlayerColor color) const;
// //armed object
// void getUpgradeInfo(const CArmedInstance *obj, SlotID stackPos, UpgradeInfo &out)const;
//hero
virtual const CGHeroInstance * getHero ( ObjectInstanceID objid ) const = 0 ;
virtual const CGHeroInstance * getHeroWithSubid ( int subid ) const = 0 ;
// int getHeroCount(PlayerColor player, bool includeGarrisoned) const;
// bool getHeroInfo(const CGObjectInstance * hero, InfoAboutHero & dest, const CGObjectInstance * selectedObject = nullptr) const;
// int32_t getSpellCost(const spells::Spell * sp, const CGHeroInstance * caster) const; //when called during battle, takes into account creatures' spell cost reduction
// int64_t estimateSpellDamage(const CSpell * sp, const CGHeroInstance * hero) const; //estimates damage of given spell; returns 0 if spell causes no dmg
// const CArtifactInstance * getArtInstance(ArtifactInstanceID aid) const;
// const CGObjectInstance * getObjInstance(ObjectInstanceID oid) const;
// const CGObjectInstance * getArmyInstance(ObjectInstanceID oid) const;
//objects
virtual const CGObjectInstance * getObj ( ObjectInstanceID objid , bool verbose = true ) const = 0 ;
// std::vector <const CGObjectInstance * > getBlockingObjs(int3 pos) const;
virtual std : : vector < const CGObjectInstance * > getVisitableObjs ( int3 pos , bool verbose = true ) const = 0 ;
// std::vector <const CGObjectInstance * > getFlaggableObjects(int3 pos) const;
// const CGObjectInstance * getTopObj (int3 pos) const;
// PlayerColor getOwner(ObjectInstanceID heroID) const;
// const CGObjectInstance *getObjByQuestIdentifier(int identifier) const; //nullptr if object has been removed (eg. killed)
//map
// int3 guardingCreaturePosition (int3 pos) const;
// std::vector<const CGObjectInstance*> getGuardingCreatures (int3 pos) const;
// const CMapHeader * getMapHeader()const;
// int3 getMapSize() const; //returns size of map - z is 1 for one - level map and 2 for two level map
// const TerrainTile * getTile(int3 tile, bool verbose = true) const;
// std::shared_ptr<boost::multi_array<TerrainTile*, 3>> getAllVisibleTiles() const;
// bool isInTheMap(const int3 &pos) const;
// void getVisibleTilesInRange(std::unordered_set<int3, ShashInt3> &tiles, int3 pos, int radious, int3::EDistanceFormula distanceFormula = int3::DIST_2D) const;
//town
// const CGTownInstance* getTown(ObjectInstanceID objid) const;
// int howManyTowns(PlayerColor Player) const;
// const CGTownInstance * getTownInfo(int val, bool mode)const; //mode = 0 -> val = player town serial; mode = 1 -> val = object id (serial)
// std::vector<const CGHeroInstance *> getAvailableHeroes(const CGObjectInstance * townOrTavern) const; //heroes that can be recruited
// std::string getTavernRumor(const CGObjectInstance * townOrTavern) const;
// EBuildingState::EBuildingState canBuildStructure(const CGTownInstance *t, BuildingID ID);//// 0 - no more than one capitol, 1 - lack of water, 2 - forbidden, 3 - Add another level to Mage Guild, 4 - already built, 5 - cannot build, 6 - cannot afford, 7 - build, 8 - lack of requirements
// virtual bool getTownInfo(const CGObjectInstance * town, InfoAboutTown & dest, const CGObjectInstance * selectedObject = nullptr) const;
// const CTown *getNativeTown(PlayerColor color) const;
//from gs
// const TeamState *getTeam(TeamID teamID) const;
// const TeamState *getPlayerTeam(PlayerColor color) const;
// EBuildingState::EBuildingState canBuildStructure(const CGTownInstance *t, BuildingID ID) const;// 0 - no more than one capitol, 1 - lack of water, 2 - forbidden, 3 - Add another level to Mage Guild, 4 - already built, 5 - cannot build, 6 - cannot afford, 7 - build, 8 - lack of requirements
//teleport
// std::vector<ObjectInstanceID> getVisibleTeleportObjects(std::vector<ObjectInstanceID> ids, PlayerColor player) const;
// std::vector<ObjectInstanceID> getTeleportChannelEntraces(TeleportChannelID id, PlayerColor Player = PlayerColor::UNFLAGGABLE) const;
// std::vector<ObjectInstanceID> getTeleportChannelExits(TeleportChannelID id, PlayerColor Player = PlayerColor::UNFLAGGABLE) const;
// ETeleportChannelType getTeleportChannelType(TeleportChannelID id, PlayerColor player = PlayerColor::UNFLAGGABLE) const;
// bool isTeleportChannelImpassable(TeleportChannelID id, PlayerColor player = PlayerColor::UNFLAGGABLE) const;
// bool isTeleportChannelBidirectional(TeleportChannelID id, PlayerColor player = PlayerColor::UNFLAGGABLE) const;
// bool isTeleportChannelUnidirectional(TeleportChannelID id, PlayerColor player = PlayerColor::UNFLAGGABLE) const;
// bool isTeleportEntrancePassable(const CGTeleport * obj, PlayerColor player) const;
} ;
2014-04-20 11:40:15 +03: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
class DLL_LINKAGE CGameInfoCallback : public virtual CCallbackBase , public IGameInfoCallback
2014-04-19 20:44:21 +03:00
{
protected :
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
CGameState * gs ; //todo: replace with protected const getter, only actual Server and Client objects should hold game state
2017-07-20 06:08:49 +02:00
2014-04-19 20:44:21 +03:00
CGameInfoCallback ( ) ;
CGameInfoCallback ( CGameState * GS , boost : : optional < PlayerColor > Player ) ;
bool hasAccess ( boost : : optional < PlayerColor > playerId ) const ;
bool isVisible ( int3 pos , boost : : optional < PlayerColor > Player ) const ;
bool isVisible ( const CGObjectInstance * obj , boost : : optional < PlayerColor > Player ) const ;
bool isVisible ( const CGObjectInstance * obj ) const ;
bool canGetFullInfo ( const CGObjectInstance * obj ) const ; //true we player owns obj or ally owns obj or privileged mode
bool isOwnedOrVisited ( const CGObjectInstance * obj ) const ;
public :
//various
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
int getDate ( Date : : EDateType mode = Date : : DAY ) const override ; //mode=0 - total days in game, mode=1 - day of week, mode=2 - current week, mode=3 - current month
2018-07-26 12:06:55 +02:00
virtual const StartInfo * getStartInfo ( bool beforeRandomization = false ) const ;
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
bool isAllowed ( int32_t type , int32_t id ) const override ; //type: 0 - spell; 1- artifact; 2 - secondary skill
2014-04-19 20:44:21 +03:00
//player
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
const Player * getPlayer ( PlayerColor color ) const override ;
virtual const PlayerState * getPlayerState ( PlayerColor color , bool verbose = true ) const ;
2018-07-26 12:06:55 +02:00
virtual int getResource ( PlayerColor Player , Res : : ERes which ) const ;
virtual bool isVisible ( int3 pos ) const ;
virtual PlayerRelations : : PlayerRelations getPlayerRelations ( PlayerColor color1 , PlayerColor color2 ) const ;
virtual void getThievesGuildInfo ( SThievesGuildInfo & thi , const CGObjectInstance * obj ) ; //get thieves' guild info obtainable while visiting given object
virtual EPlayerStatus : : EStatus getPlayerStatus ( PlayerColor player , bool verbose = true ) const ; //-1 if no such player
virtual PlayerColor getCurrentPlayer ( ) const ; //player that currently makes move // TODO synchronous turns
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
PlayerColor getLocalPlayer ( ) const override ; //player that is currently owning given client (if not a client, then returns current player)
2018-07-26 12:06:55 +02:00
virtual const PlayerSettings * getPlayerSettings ( PlayerColor color ) const ;
2014-04-19 20:44:21 +03:00
//armed object
2018-07-26 12:06:55 +02:00
virtual void getUpgradeInfo ( const CArmedInstance * obj , SlotID stackPos , UpgradeInfo & out ) const ;
2014-04-19 20:44:21 +03:00
//hero
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
virtual const CGHeroInstance * getHero ( ObjectInstanceID objid ) const override ;
const CGHeroInstance * getHeroWithSubid ( int subid ) const override ;
2018-07-26 12:06:55 +02:00
virtual int getHeroCount ( PlayerColor player , bool includeGarrisoned ) const ;
virtual bool getHeroInfo ( const CGObjectInstance * hero , InfoAboutHero & dest , const CGObjectInstance * selectedObject = nullptr ) const ;
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
virtual int32_t getSpellCost ( const spells : : Spell * sp , const CGHeroInstance * caster ) const ; //when called during battle, takes into account creatures' spell cost reduction
2018-07-26 12:06:55 +02:00
virtual int64_t estimateSpellDamage ( const CSpell * sp , const CGHeroInstance * hero ) const ; //estimates damage of given spell; returns 0 if spell causes no dmg
virtual const CArtifactInstance * getArtInstance ( ArtifactInstanceID aid ) const ;
virtual const CGObjectInstance * getObjInstance ( ObjectInstanceID oid ) const ;
//virtual const CGObjectInstance * getArmyInstance(ObjectInstanceID oid) const;
2014-04-19 20:44:21 +03:00
//objects
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
virtual const CGObjectInstance * getObj ( ObjectInstanceID objid , bool verbose = true ) const override ;
2018-07-26 12:06:55 +02:00
virtual std : : vector < const CGObjectInstance * > getBlockingObjs ( int3 pos ) const ;
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
virtual std : : vector < const CGObjectInstance * > getVisitableObjs ( int3 pos , bool verbose = true ) const override ;
2018-07-26 12:06:55 +02:00
virtual std : : vector < const CGObjectInstance * > getFlaggableObjects ( int3 pos ) const ;
virtual const CGObjectInstance * getTopObj ( int3 pos ) const ;
virtual PlayerColor getOwner ( ObjectInstanceID heroID ) const ;
virtual const CGObjectInstance * getObjByQuestIdentifier ( int identifier ) const ; //nullptr if object has been removed (eg. killed)
2014-04-19 20:44:21 +03:00
//map
2018-07-26 12:06:55 +02:00
virtual int3 guardingCreaturePosition ( int3 pos ) const ;
virtual std : : vector < const CGObjectInstance * > getGuardingCreatures ( int3 pos ) const ;
virtual const CMapHeader * getMapHeader ( ) const ;
virtual int3 getMapSize ( ) const ; //returns size of map - z is 1 for one - level map and 2 for two level map
virtual const TerrainTile * getTile ( int3 tile , bool verbose = true ) const ;
2022-09-18 16:39:10 +02:00
virtual std : : shared_ptr < const boost : : multi_array < TerrainTile * , 3 > > getAllVisibleTiles ( ) const ;
2018-07-26 12:06:55 +02:00
virtual bool isInTheMap ( const int3 & pos ) const ;
virtual void getVisibleTilesInRange ( std : : unordered_set < int3 , ShashInt3 > & tiles , int3 pos , int radious , int3 : : EDistanceFormula distanceFormula = int3 : : DIST_2D ) const ;
2021-05-16 19:53:11 +02:00
virtual void calculatePaths ( std : : shared_ptr < PathfinderConfig > config ) ;
2014-04-19 20:44:21 +03:00
//town
2018-07-26 12:06:55 +02:00
virtual const CGTownInstance * getTown ( ObjectInstanceID objid ) const ;
virtual int howManyTowns ( PlayerColor Player ) const ;
//virtual const CGTownInstance * getTownInfo(int val, bool mode)const; //mode = 0 -> val = player town serial; mode = 1 -> val = object id (serial)
virtual std : : vector < const CGHeroInstance * > getAvailableHeroes ( const CGObjectInstance * townOrTavern ) const ; //heroes that can be recruited
virtual std : : string getTavernRumor ( const CGObjectInstance * townOrTavern ) const ;
virtual EBuildingState : : EBuildingState canBuildStructure ( const CGTownInstance * t , BuildingID ID ) ; //// 0 - no more than one capitol, 1 - lack of water, 2 - forbidden, 3 - Add another level to Mage Guild, 4 - already built, 5 - cannot build, 6 - cannot afford, 7 - build, 8 - lack of requirements
2015-02-06 16:36:09 +02:00
virtual bool getTownInfo ( const CGObjectInstance * town , InfoAboutTown & dest , const CGObjectInstance * selectedObject = nullptr ) const ;
2018-07-26 12:06:55 +02:00
virtual const CTown * getNativeTown ( PlayerColor color ) const ;
2014-04-19 20:44:21 +03:00
//from gs
2018-07-26 12:06:55 +02:00
virtual const TeamState * getTeam ( TeamID teamID ) const ;
virtual const TeamState * getPlayerTeam ( PlayerColor color ) const ;
//virtual EBuildingState::EBuildingState canBuildStructure(const CGTownInstance *t, BuildingID ID) const;// 0 - no more than one capitol, 1 - lack of water, 2 - forbidden, 3 - Add another level to Mage Guild, 4 - already built, 5 - cannot build, 6 - cannot afford, 7 - build, 8 - lack of requirements
2015-03-08 15:21:14 +02:00
//teleport
2018-07-26 12:06:55 +02:00
virtual std : : vector < ObjectInstanceID > getVisibleTeleportObjects ( std : : vector < ObjectInstanceID > ids , PlayerColor player ) const ;
virtual std : : vector < ObjectInstanceID > getTeleportChannelEntraces ( TeleportChannelID id , PlayerColor Player = PlayerColor : : UNFLAGGABLE ) const ;
virtual std : : vector < ObjectInstanceID > getTeleportChannelExits ( TeleportChannelID id , PlayerColor Player = PlayerColor : : UNFLAGGABLE ) const ;
virtual ETeleportChannelType getTeleportChannelType ( TeleportChannelID id , PlayerColor player = PlayerColor : : UNFLAGGABLE ) const ;
virtual bool isTeleportChannelImpassable ( TeleportChannelID id , PlayerColor player = PlayerColor : : UNFLAGGABLE ) const ;
virtual bool isTeleportChannelBidirectional ( TeleportChannelID id , PlayerColor player = PlayerColor : : UNFLAGGABLE ) const ;
virtual bool isTeleportChannelUnidirectional ( TeleportChannelID id , PlayerColor player = PlayerColor : : UNFLAGGABLE ) const ;
virtual bool isTeleportEntrancePassable ( const CGTeleport * obj , PlayerColor player ) const ;
2014-04-19 20:44:21 +03:00
} ;
class DLL_LINKAGE CPlayerSpecificInfoCallback : public CGameInfoCallback
{
public :
2018-07-26 12:06:55 +02:00
virtual int howManyTowns ( ) const ;
virtual int howManyHeroes ( bool includeGarrisoned = true ) const ;
virtual int3 getGrailPos ( double * outKnownRatio ) ;
virtual boost : : optional < PlayerColor > getMyColor ( ) const ;
virtual std : : vector < const CGTownInstance * > getTownsInfo ( bool onlyOur = true ) const ; //true -> only owned; false -> all visible
virtual int getHeroSerial ( const CGHeroInstance * hero , bool includeGarrisoned = true ) const ;
virtual const CGTownInstance * getTownBySerial ( int serialId ) const ; // serial id is [0, number of towns)
virtual const CGHeroInstance * getHeroBySerial ( int serialId , bool includeGarrisoned = true ) const ; // serial id is [0, number of heroes)
virtual std : : vector < const CGHeroInstance * > getHeroesInfo ( bool onlyOur = true ) const ; //true -> only owned; false -> all visible
virtual std : : vector < const CGDwelling * > getMyDwellings ( ) const ; //returns all dwellings that belong to player
virtual std : : vector < const CGObjectInstance * > getMyObjects ( ) const ; //returns all objects flagged by belonging player
virtual std : : vector < QuestInfo > getMyQuests ( ) const ;
virtual int getResourceAmount ( Res : : ERes type ) const ;
virtual TResources getResourceAmount ( ) const ;
2022-09-18 16:39:10 +02:00
virtual std : : shared_ptr < const boost : : multi_array < ui8 , 3 > > getVisibilityMap ( ) const ; //returns visibility map
2018-07-26 12:06:55 +02:00
//virtual const PlayerSettings * getPlayerSettings(PlayerColor color) const;
2014-04-19 20:44:21 +03:00
} ;
2022-07-26 15:07:42 +02:00
VCMI_LIB_NAMESPACE_END
