1
0
mirror of https://github.com/vcmi/vcmi.git synced 2024-12-10 09:50:17 +02:00
vcmi/lib/CCreatureSet.h

219 lines
8.3 KiB
C
Raw Normal View History

#pragma once
2010-04-02 05:23:22 +03:00
#include "HeroBonus.h"
#include "GameConstants.h"
2012-01-30 19:07:52 +03:00
#include "CArtHandler.h"
2010-04-02 05:23:22 +03:00
2012-12-19 17:54:10 +03:00
/*
* CCreatureSet.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
*
*/
2010-04-02 05:23:22 +03:00
class CCreature;
class CGHeroInstance;
class CArmedInstance;
2012-01-30 19:07:52 +03:00
class CCreatureArtifactSet;
2010-04-02 05:23:22 +03:00
class DLL_LINKAGE CStackBasicDescriptor
{
public:
const CCreature *type;
TQuantity count;
CStackBasicDescriptor();
CStackBasicDescriptor(CreatureID id, TQuantity Count);
CStackBasicDescriptor(const CCreature *c, TQuantity Count);
template <typename Handler> void serialize(Handler &h, const int version)
{
h & type & count;
}
};
class DLL_LINKAGE CStackInstance : public CBonusSystemNode, public CStackBasicDescriptor, public CArtifactSet
2010-04-02 05:23:22 +03:00
{
protected:
const CArmedInstance *_armyObj; //stack must be part of some army, army must be part of some object
2010-04-02 05:23:22 +03:00
public:
// hlp variable used during loading map, when object (hero or town) have creatures that must have same alignment.
// idRand < 0 -> normal, non-random creature
// idRand / 2 -> level
// idRand % 2 -> upgrade number
int idRand;
const CArmedInstance * const & armyObj; //stack must be part of some army, army must be part of some object
TExpType experience;//commander needs same amount of exp as hero
2010-04-02 05:23:22 +03:00
template <typename Handler> void serialize(Handler &h, const int version)
{
h & static_cast<CBonusSystemNode&>(*this);
h & static_cast<CStackBasicDescriptor&>(*this);
h & static_cast<CArtifactSet&>(*this);
h & _armyObj & experience;
BONUS_TREE_DESERIALIZATION_FIX
2010-04-02 05:23:22 +03:00
}
//overrides CBonusSystemNode
std::string bonusToString(const Bonus *bonus, bool description) const override; // how would bonus description look for this particular type of node
std::string bonusToGraphics(const Bonus *bonus) const; //file name of graphics from StackSkills , in future possibly others
virtual ui64 getPower() const;
2010-04-02 05:23:22 +03:00
int getQuantityID() const;
std::string getQuantityTXT(bool capitalized = true) const;
virtual int getExpRank() const;
virtual int getLevel() const; //different for regular stack and commander
si32 magicResistance() const;
CreatureID getCreatureID() const; //-1 if not available
std::string getName() const; //plural or singular
virtual void init();
2010-04-02 05:23:22 +03:00
CStackInstance();
CStackInstance(CreatureID id, TQuantity count);
2010-04-02 05:23:22 +03:00
CStackInstance(const CCreature *cre, TQuantity count);
~CStackInstance();
void setType(CreatureID creID);
void setType(const CCreature *c);
void setArmyObj(const CArmedInstance *ArmyObj);
virtual void giveStackExp(TExpType exp);
bool valid(bool allowUnrandomized) const;
ArtBearer::ArtBearer bearerType() const override; //from CArtifactSet
virtual std::string nodeName() const override; //from CBonusSystemnode
void deserializationFix();
2010-04-02 05:23:22 +03:00
};
class DLL_LINKAGE CCommanderInstance : public CStackInstance
{
public:
//TODO: what if Commander is not a part of creature set?
//commander class is determined by its base creature
ui8 alive;
ui8 level; //required only to count callbacks
std::string name; // each Commander has different name
std::vector <ui8> secondarySkills; //ID -> level
std::set <ui8> specialSKills;
//std::vector <CArtifactInstance *> arts;
void init() override;
CCommanderInstance();
CCommanderInstance (CreatureID id);
~CCommanderInstance();
void setAlive (bool alive);
void giveStackExp (TExpType exp);
void levelUp ();
bool gainsLevel() const; //true if commander has lower level than should upon his experience
ui64 getPower() const {return 0;};
int getExpRank() const;
int getLevel() const override;
ArtBearer::ArtBearer bearerType() const override; //from CArtifactSet
template <typename Handler> void serialize(Handler &h, const int version)
{
h & static_cast<CStackInstance&>(*this);
h & alive & level & name & secondarySkills & specialSKills;
}
};
DLL_LINKAGE std::ostream & operator<<(std::ostream & str, const CStackInstance & sth);
2010-04-02 05:23:22 +03:00
2013-02-16 17:03:47 +03:00
typedef std::map<SlotID, CStackInstance*> TSlots;
typedef std::map<SlotID, CStackBasicDescriptor> TSimpleSlots;
2010-04-02 05:23:22 +03:00
class IArmyDescriptor
{
public:
virtual void clear() = 0;
2013-02-16 17:03:47 +03:00
virtual bool setCreature(SlotID slot, CreatureID cre, TQuantity count) = 0;
};
//simplified version of CCreatureSet
class DLL_LINKAGE CSimpleArmy : public IArmyDescriptor
{
public:
TSimpleSlots army;
void clear() override;
bool setCreature(SlotID slot, CreatureID cre, TQuantity count) override;
operator bool() const;
template <typename Handler> void serialize(Handler &h, const int version)
{
h & army;
}
};
class DLL_LINKAGE CCreatureSet : public IArmyDescriptor //seven combined creatures
2010-04-02 05:23:22 +03:00
{
CCreatureSet(const CCreatureSet&);
CCreatureSet &operator=(const CCreatureSet&);
2010-04-02 05:23:22 +03:00
public:
2011-01-21 04:36:30 +02:00
TSlots stacks; //slots[slot_id]->> pair(creature_id,creature_quantity)
2010-04-02 05:23:22 +03:00
ui8 formation; //false - wide, true - tight
CCreatureSet();
virtual ~CCreatureSet();
virtual void armyChanged();
2013-02-16 17:03:47 +03:00
const CStackInstance &operator[](SlotID slot) const;
2010-04-02 05:23:22 +03:00
2011-01-21 04:36:30 +02:00
const TSlots &Slots() const {return stacks;}
2010-04-02 05:23:22 +03:00
2013-02-16 17:03:47 +03:00
void addToSlot(SlotID slot, CreatureID cre, TQuantity count, bool allowMerging = true); //Adds stack to slot. Slot must be empty or with same type creature
void addToSlot(SlotID slot, CStackInstance *stack, bool allowMerging = true); //Adds stack to slot. Slot must be empty or with same type creature
void clear() override;
void setFormation(bool tight);
CArmedInstance *castToArmyObj();
//basic operations
2013-02-16 17:03:47 +03:00
void putStack(SlotID slot, CStackInstance *stack); //adds new stack to the army, slot must be empty
void setStackCount(SlotID slot, TQuantity count); //stack must exist!
CStackInstance *detachStack(SlotID slot); //removes stack from army but doesn't destroy it (so it can be moved somewhere else or safely deleted)
void setStackType(SlotID slot, const CCreature *type);
void giveStackExp(TExpType exp);
2013-02-16 17:03:47 +03:00
void setStackExp(SlotID slot, TExpType exp);
//derivative
2013-02-16 17:03:47 +03:00
void eraseStack(SlotID slot); //slot must be occupied
void joinStack(SlotID slot, CStackInstance * stack); //adds new stack to the existing stack of the same type
void changeStackCount(SlotID slot, TQuantity toAdd); //stack must exist!
bool setCreature (SlotID slot, CreatureID type, TQuantity quantity) override; //replaces creature in stack; slots 0 to 6, if quantity=0 erases stack
void setToArmy(CSimpleArmy &src); //erases all our army and moves stacks from src to us; src MUST NOT be an armed object! WARNING: use it wisely. Or better do not use at all.
2013-02-16 17:03:47 +03:00
const CStackInstance& getStack(SlotID slot) const; //stack must exist
const CStackInstance* getStackPtr(SlotID slot) const; //if stack doesn't exist, returns nullptr
2013-02-16 17:03:47 +03:00
const CCreature* getCreature(SlotID slot) const; //workaround of map issue;
int getStackCount (SlotID slot) const;
TExpType getStackExperience(SlotID slot) const;
SlotID findStack(const CStackInstance *stack) const; //-1 if none
SlotID getSlotFor(CreatureID creature, ui32 slotsAmount = GameConstants::ARMY_SIZE) const; //returns -1 if no slot available
SlotID getSlotFor(const CCreature *c, ui32 slotsAmount = GameConstants::ARMY_SIZE) const; //returns -1 if no slot available
SlotID getFreeSlot(ui32 slotsAmount = GameConstants::ARMY_SIZE) const;
bool mergableStacks(std::pair<SlotID, SlotID> &out, SlotID preferable = SlotID()) const; //looks for two same stacks, returns slot positions;
2010-04-02 05:23:22 +03:00
bool validTypes(bool allowUnrandomized = false) const; //checks if all types of creatures are set properly
2013-02-16 17:03:47 +03:00
bool slotEmpty(SlotID slot) const;
int stacksCount() const;
virtual bool needsLastStack() const; //true if last stack cannot be taken
ui64 getArmyStrength() const; //sum of AI values of creatures
2013-02-16 17:03:47 +03:00
ui64 getPower (SlotID slot) const; //value of specific stack
std::string getRoughAmount (SlotID slot) const; //rough size of specific stack
bool hasStackAtSlot(SlotID slot) const;
bool contains(const CStackInstance *stack) const;
bool canBeMergedWith(const CCreatureSet &cs, bool allowMergingStacks = true) const;
2010-04-02 05:23:22 +03:00
template <typename Handler> void serialize(Handler &h, const int version)
{
2011-01-21 04:36:30 +02:00
h & stacks & formation;
2010-04-02 05:23:22 +03:00
}
operator bool() const
{
2013-11-03 15:51:25 +03:00
return !stacks.empty();
2010-04-02 05:23:22 +03:00
}
void sweep();
};