bs/fleet.h

   1 /***************************************************************************
   2                           fleet.h  -  description
   3                              -------------------
   4     begin                : Tue Jan 22 2002
   5     copyright            : (C) 2002 by Michael Andreen
   6     email                : whale@linux.nu
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef FLEET_H
  19 #define FLEET_H
  20
  21 #include <map>
  22 #include <ext/hash_map>
  23 #include <string>
  24 #include <vector>
  25
  26 #include "unittype.h"
  27  template<typename T> class MyComp { public: bool operator()(T,T) { return false; } };
  28 typedef std::map<std::string, std::vector<int> > FleetList;
  29 typedef std::map<std::string, UnitType> UnitList;
  30 typedef std::map<std::string, std::vector<int> > RaceList;
  31 typedef std::map<std::string, std::vector<int> > ResourceList;
  32 typedef std::map<std::string, int> ArmorList;
  33 //! An abstraction of a fleet and the engine for the battle simulation.
  34 /**This class and it's derivates is  the engine for the whole battlesystem.
  35   *     One of the few parts that I plan make fully portable.
  36   *\todo LOTS (I think ;)
  37   *@author Michael Andreen
  38   */
  39 class Fleet
  40 {
  41 public:
  42         Fleet();
  43         virtual ~Fleet();
  44
  45         /**Sets the name that represents this fleet. Might be different a name
  46          * like foobar or some coordinates like 1:1:1. The name doesn't have to be
  47          * unique, since it's up to the rest of the program to handle that part.
  48          * \see Name
  49          */
  50         void   setName(std::string sName);
  51
  52         /**Returns the name of this fleet.
  53          * \see setName
  54          */
  55         std::string name() const;
  56
  57         /**The race string decides what type of ships this fleet can have.
  58          * The values must be feeded into this class.
  59          * \param sRace This is just the name of the race. It's case-sensitive.
  60          * \return If the race is available this function returns true, if not false
  61          * is returned. The race is set in both cases though.
  62          * \see Race
  63          */
  64         bool   setRace(std::string sRace);
  65
  66         /**Just returns what race this fleet belongs to..
  67          * \return The race, represented as a string.
  68          * \see setRace
  69          */
  70         std::string race() const;
  71
  72         /**Returns the ship races allowed for this fleet.. This is not a hard limit
  73          * it's more a indication to the interface what should be shown or not, the
  74          * class can still handle all the different shiptypes.
  75          * \return a vector of ints that can be used to compare with Unittype::race()
  76          * \see Unittype::race()
  77          */
  78         std::vector<int> RacesAllowed() const;
  79
  80         /**Returns the total number of ships in this fleet
  81          */
  82         int numberOfShips() const;
  83
  84         /**Sets the estimated time of arrival. The time as a single integer,
  85          * in relation to the current time. For example if the current time is
  86          * 10, and the arrival is at 12, then the eta is 2.
  87          */
  88         void setETA(int eta);
  89
  90         /**Return the estimated time of arrival. It's counted from the current time (tick).
  91          */
  92         int  ETA() const;
  93
  94
  95         /**Returns the score. This value is the total resources spent on this fleet
  96          * devided with 10.
  97          * \param tick tells the function what tick you want the score from. 0 is
  98          * initial score before the fleet has landed.
  99          */
 100         unsigned score(int tick = 0) const;
 101
 102         /**This function is used to set the number of units for a specific tic.
 103          * \param untitype the unittype's name, as a std string
 104          * \param number the number of ships
 105          * \param tick what tick to set for. Tick 0 (before battle) is standard, no
 106          * other is hardly used other than inside the engine.
 107          */
 108         void setFleet(std::string unittype, int number, int tick = 0);
 109         /**Returns the numbers of units fo a specific type at a specific tick.
 110          * \param unittype The shipname, as a std string
 111          * \param tick The tick you want to look at, tick 0 (before battle) is default
 112          * \return returns the number of units that params specifies.
 113          */
 114         int      fleet(std::string unittype, int tick = 0);
 115
 116         /**Returns the number of free ships, that is: ships that aren't dead and not
 117          * blocked.
 118          * \param unittype The shipname, as a std string
 119          * \param tick The tick you want to look at, tick 0 (before battle) is default
 120          * \return returns the number of units that params specifies.
 121          */
 122         int freeFleet(std:: string unittype, int tick = 0);
 123
 124         /** This function is used to see how many ships of a specific type got
 125          * blocked at a specific tick.
 126          * \param unittype the name of the unittype
 127          * \param tick what tick you want to look at
 128          * \return the number of ships that got blocked at the specified tick.
 129          */
 130         int blockedFleet(std::string unittype, int tick = 0);
 131
 132         void setBlockedFleet(std::string unittype, int number, int tick = 0);
 133
 134         /** This function takes the vector with fleets and adds all their units of the
 135          * specific tick to the current fleet's first tick. Main usage is for battle
 136          * calculations.
 137          * \param fleets a vector with fleet pointers
 138          * \param tick an int to specify what tick to use. tick 0 (before battle)
 139          * is default
 140          * \todo add another tick parameter to specify what tick to use in the
 141          * current fleet.
 142          */
 143         void addToThis(std::vector<Fleet*> fleets, int tick = 0);
 144
 145         /** This function takes a vector with fleets and distribute all ship losses
 146          * between tick 0 and 1 in the current fleet and adds that to the specified
 147          * tick in each fleet.
 148          * \param fleets a vector with fleet pointers that holds the fleets that's
 149          * going to share the losses.
 150          * \param tick the tick to add the losses to for the fleets in the vector.
 151          * \todo add another tick parameter to specify what tick to use in the
 152          * current fleet.
 153          */
 154         void distributeLossesGains(std::vector<Fleet*> fleets, int tick = 0);
 155
 156         /** This functions takes the captured roids between tick 0 and 1 in the
 157          * current fleet and divides them between the fleets given as param.
 158          * \param fleets a vector with Fleet pointers, points to the fleets that
 159          * should get parts of the roids.
 160          * \param tick the tick to use in the fleets given as argument, when the
 161          * roids are handed out.
 162          * \todo add another tick parameter to specify what tick to use in the
 163          * current fleet.
 164          */
 165         void distributeCappedRoids(std::vector<Fleet*> fleets, int tick = 0);
 166
 167         /** Checks through the vector with fleets to see who's in time for the
 168          * specified tick and staying long enough so they're not too early.
 169          * \param fleets a vector with Fleet pointers to use for the calculations
 170          * \param stays the number of ticks the fleets stays, will be obsolee when
 171          * I get the time.
 172          * \param tick What the current tick is to use for the calculations
 173          * \return returns a vector with the fleet that are in time for the battle
 174          * and are staying long enough.
 175          * \todo add the stays part as a integrated part of each fleet.
 176          */
 177         std::vector<Fleet*> calculateSide(std::vector<Fleet*> fleets, int stays = 0, int tick = 0);
 178
 179         /** Kill some ships of the specified type in the current fleet.
 180          * \param unittype the name of the unit to kill
 181          * \param number how many ships to kill
 182          * \param tick what tick they where killed.
 183          */
 184         void killFleet(std::string unittype, int number, int tick = 0);
 185
 186         /**Block some ships of the specified type in the current fleet.
 187          * \param unittype the name of the unit to block
 188          * \param number how many ships to block
 189          * \param tick what tick they where blocked.
 190          */
 191         void blockFleet(std::string unittype, int number, int tick = 0);
 192
 193         /** Set the resources of the specified type for the tick.
 194          *
 195          * \param type The name of the resource (in pa: metal,
 196          * crystal and eonium (+ uninit for roids).
 197          * \param number just simply the number of the specified resource.
 198          * \param tick what tick to set
 199          * \sa resource
 200          */
 201         void setResource(std::string type, int number, int tick = 0);
 202
 203         /** Adds a number ot the specified resource type.
 204          * \param type The name of the resource (in pa: metal,
 205          * crystal and eonium (+ uninit for roids).
 206          * \param number just simply the number of the specified resource.
 207          * \param tick what tick to set
 208          * \sa resource
 209          */
 210         void addResource(std::string type, int number, int tick = 0);
 211
 212         /** Looks up the how much of a specific resource type the current fleet has.
 213          *
 214          * Resources is a kinda vague word, in general it's used as roid capping
 215          * for hostile fleet and as salvage for friendly.
 216          * \param type The name of the resource (in pa: metal,
 217          * crystal and eonium (+ uninit for roids).
 218          * \param tick what tick to set
 219          * \returns simply returns the number of the specific resource this fleet
 220          * has.
 221          */
 222         int resource(std::string type, int tick = 0)const;
 223
 224         /** This is a little more advanced function. It makes a a number of units
 225          * of a specific unittype shoot at the current fleet and calculates the
 226          * losses.
 227          *
 228          * Atm all calculations are done for tick 0/1
 229          * \param unittype The name of the unit that shots at the current fleet.
 230          * \param number The number of the specific unittype that shoot.
 231          * \param hitunits a map to count the number of killed units, just if the
 232          * rest of the program needs it.
 233          * \todo add a parameter to specify what tick to calc for and move out as
 234          * much of the code as possible because it's kinda crowded atm and lots of
 235          * very similar stuff in both the take* functions.
 236          * \sa takeEMP
 237          */
 238         void takeShoot(std::string unittype, int number, std::map<std::string, int>& hitunits);
 239
 240         /**This is a little more advanced function. It makes a a number of units
 241          * of a specific unittype shoot at the current fleet and calculates how
 242          * many got blocked..
 243          *
 244          * Atm all calculations are done for tick 0/1
 245          * \param unittype The name of the unit that shots at the current fleet.
 246          * \param number The number of the specific unittype that shoot.
 247          * \todo add a parameter to specify what tick to calc for and move out as
 248          * much of the code as possible because it's kinda crowded atm and lots of
 249          * very similar stuff in both the take* functions.
 250          * \sa takeShoot
 251          */
 252         void takeEMP(std::string unittype, int number);
 253
 254         /** This function prints out all the ships in the fleet to stderr,
 255          * mainly used for debugging.
 256          */
 257         void printFleet();
 258
 259         //static functions
 260         //
 261         /** This function is used to set the different races used.
 262          * \param races a Simple RaceList which holds all the info
 263          */
 264         static void setRaces(RaceList& races);
 265
 266         /** This function is used to set all the units used in the game.
 267          * \param units This is a simple UnitList holding all info needed.
 268          */
 269         static void setUnits(UnitList& units);
 270
 271         /** This function is used to get the list of races used.
 272          * \returns it returns a simple RaceList just like the one that set it.
 273          */
 274         static const RaceList& Races();
 275
 276         /** This function is used to get the list of all the units in the game
 277          * \returns a simple UnitList holding everything.
 278          */
 279         static const UnitList& Units();
 280
 281
 282 protected:
 283
 284
 285         std::string     m_sName;
 286         std::string     m_sRace;
 287         int         m_iETA;
 288         FleetList       m_Fleet;
 289         FleetList       m_BlockedFleet;
 290         ResourceList m_Resources;
 291         ArmorList       m_Armor;
 292
 293
 294
 295         static UnitList s_Units;
 296         static RaceList s_Races;
 297 };
 298
 299 #endif