games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-12-22 00:27:58 +02:00
Code Issues Releases Activity

refactor: improve comments in CGameInfoCallback and MapInfoCallback; empty line to avoid using separator as a comment in IDE

Browse Source
This commit is contained in:
Mircea TheHonestCTO
2025-09-27 03:25:45 +02:00
parent 5dc3934720
commit 08ae8bef5a
3 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
lib/callback/CGameInfoCallback.h
View File

@@ -20,18 +20,18 @@ class DLL_LINKAGE CGameInfoCallback : public MapInfoCallback
{
protected:
const CMap * getMapConstPtr() const override;
bool hasAccess(std::optional<PlayerColor> playerId) const;
bool canGetFullInfo(const CGObjectInstance *obj) const; //true we player owns obj or ally owns obj or privileged mode
public:
//various
int getDate(Date mode=Date::DAY)const override; //mode=0 - total days in game, mode=1 - day of week, mode=2 - current week, mode=3 - current month
const StartInfo * getStartInfo() const override;
const StartInfo * getInitialStartInfo() const;
//player
virtual std::optional<PlayerColor> getPlayerID() const;
const Player * getPlayer(PlayerColor color) const;
const PlayerState * getPlayerState(PlayerColor color, bool verbose = true) const override;
@@ -44,15 +44,18 @@ public:
TurnTimerInfo getPlayerTurnTime(PlayerColor color) const;
//map
bool isVisibleFor(int3 pos, PlayerColor player) const override;
bool isVisibleFor(const CGObjectInstance * obj, PlayerColor player) const override;
bool isVisible(const CGObjectInstance * obj) const;
bool isVisible(int3 pos) const;
//armed object
void fillUpgradeInfo(const CArmedInstance *obj, SlotID stackPos, UpgradeInfo &out) const;
//hero
int getHeroCount(PlayerColor player, bool includeGarrisoned) const override;
std::vector<const CGHeroInstance*> getHeroes(PlayerColor player) const;
bool getHeroInfo(const CGObjectInstance * hero, InfoAboutHero & dest, const CGObjectInstance * selectedObject = nullptr) const;
@@ -61,7 +64,8 @@ public:
const CArtifactSet * getArtSet(const ArtifactLocation & loc) const;
//objects
const CGObjectInstance * getObj(ObjectInstanceID objId, bool verbose = true) const override;
const CGObjectInstance * getObj(ObjectInstanceID objId, bool verbose = true) const override; // Get with some checks and visibility checks. Raw get is MapInfoCallback::getObjInstance
std::vector<const CGObjectInstance *> getBlockingObjs(int3 pos) const;
std::vector<const CGObjectInstance *> getVisitableObjs(int3 pos, bool verbose = true) const;
std::vector<const CGObjectInstance *> getAllVisitableObjs() const;
@@ -70,6 +74,7 @@ public:
const IMarket * getMarket(ObjectInstanceID objid) const;
//map
int3 guardingCreaturePosition (int3 pos) const override;
std::vector<const CGObjectInstance*> getGuardingCreatures (int3 pos) const override;
bool isTileGuardedUnchecked(int3 tile) const override;
@@ -81,6 +86,7 @@ public:
bool checkForVisitableDir(const int3 & src, const int3 & dst) const override;
//town
int howManyTowns(PlayerColor Player) const;
std::vector<const CGHeroInstance *> getAvailableHeroes(const CGObjectInstance * townOrTavern) const;
std::string getTavernRumor(const CGObjectInstance * townOrTavern) const;
@@ -88,10 +94,12 @@ public:
bool getTownInfo(const CGObjectInstance * town, InfoAboutTown & dest, const CGObjectInstance * selectedObject = nullptr) const;
//from gs
const TeamState *getTeam(TeamID teamID) const override;
const TeamState *getPlayerTeam(PlayerColor color) const override;
//teleport
std::vector<ObjectInstanceID> getVisibleTeleportObjects(std::vector<ObjectInstanceID> ids, PlayerColor player) const override;
std::vector<ObjectInstanceID> getTeleportChannelEntrances(TeleportChannelID id, PlayerColor Player = PlayerColor::UNFLAGGABLE) const override;
std::vector<ObjectInstanceID> getTeleportChannelExits(TeleportChannelID id, PlayerColor Player = PlayerColor::UNFLAGGABLE) const override;
@@ -102,6 +110,7 @@ public:
bool isTeleportEntrancePassable(const CGTeleport * obj, PlayerColor player) const override;
//used for random spawns
void getFreeTiles(std::vector<int3> &tiles, bool skipIfNearbyGuarded) const;
void getTilesInRange(FowTilesType & tiles, const int3 & pos, int radius, ETileVisibility mode, std::optional<PlayerColor> player = std::optional<PlayerColor>(), int3::EDistanceFormula formula = int3::DIST_2D) const override;
void getAllTiles(FowTilesType &tiles, std::optional<PlayerColor> player, int level, const std::function<bool(const TerrainTile *)> & filter) const override;

2
lib/callback/MapInfoCallback.cpp
View File

@@ -72,7 +72,7 @@ const CArtifactInstance * MapInfoCallback::getArtInstance(ArtifactInstanceID aid
const CGObjectInstance * MapInfoCallback::getObjInstance(ObjectInstanceID oid) const
{
return getMapConstPtr()->getObject((oid));
return getMapConstPtr()->getObject(oid);
}
bool MapInfoCallback::isInTheMap(const int3 & pos) const

4
lib/callback/MapInfoCallback.h
View File

@@ -23,8 +23,8 @@ protected:
public:
virtual ~MapInfoCallback();
const CGObjectInstance * getObj(ObjectInstanceID objId, bool verbose = true) const override;
const CGObjectInstance * getObjInstance(ObjectInstanceID oid) const override;
const CGObjectInstance * getObj(ObjectInstanceID objId, bool verbose = true) const override; // Raw get with some checks
const CGObjectInstance * getObjInstance(ObjectInstanceID oid) const override; // Raw get. For "safer" get with some checks, see CGameInfoCallback::getObj
const CArtifactInstance * getArtInstance(ArtifactInstanceID aid) const override;
const CGHeroInstance * getHero(ObjectInstanceID objid) const override;
const CGTownInstance * getTown(ObjectInstanceID objid) const override;