Ship.h

Go to the documentation of this file.

/*
Copyright 2003 - 2005 Elliott Kleinrock, Dan Neely, Kurt W. Over, Damon Domjan

This file is part of FreeStars, a free clone of the Stars! game.

FreeStars is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

FreeStars is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with FreeStars; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

The full GPL Copyright notice should be in the file COPYING.txt

Contact:
Email Elliott at 9jm0tjj02@sneakemail.com
*/

#if !defined(Ship_h)
#define Ship_h

#include <string>
#include <list>

class Player;
class CargoHolder;

#include "Slot.h"
#include "Cost.h"

class Component;
class Hull;

class Ship {
public:
        Ship();
        virtual ~Ship();
        static void Cleanup();

        bool ParseNode(const TiXmlNode * node, Player * player, bool other);
        void WriteNode(TiXmlNode * node, bool Host, bool Owner, bool SeeDesign) const;

        bool IsValidDesign() const;                                                     // is this design valid (no weapons in the engine slot...)
        bool IsValidDesign(const Player * player) const;        // can this player build this ship (right PRT/LRT and tech levels)

        long TechLevel(TechType tech) const;
        const Cost & GetCost(const Player * owner, const Ship * from =NULL, const Planet * planet =NULL) const;
        
        string GetName() const                                  { return mName; }
        bool IsGift() const                                             { return mGift; }
//      bool CanSteal(CargoType ct, CargoHolder * dest) const;
        bool CanStealShip() const;
        bool CanStealPlanet() const;
        long GetScanPen(const Player * player, long pop = 0) const;
        long GetScanSpace(const Player * player, long pop = 0) const;
        long GetCloaking() const;
        long GetFuelCapacity() const;
        long GetFuelGen() const;
        long GetMass() const;
        double GetTachyon() const;
        long GetCargoCapacity() const;
        long GetShield(const Player * p) const;
        long GetArmor(const Player * p) const;
        long GetSweeping() const;
        long GetInitAdj() const;
        double GetSpeedBonus() const;
        long GetMines() const;
        long GetARMaxPop() const;
        long GetDock() const;
    double GetCompPower() const;
    double GetJamming() const;
    double GetCapacitors() const;
    double GetDeflection() const;
        double GetDampener() const;
        double GetRepairRate() const;
        bool DoesRadiate(HabType ht) const;
        bool CanColonize() const;
        bool CanRefuel() const;
    long GetDriverSpeed() const;
        long CountDrivers() const;

        long GetTerraPower(long type) const;
        long GetMineAmount(long type) const;
        double GetFuelUsage(long speed) const;
        long GetSafeSpeed() const;
        long GetMaxSpeed() const;
        long GetBattleSpeed() const;
        long GetFreeSpeed() const;
        long GetRating() const;
        bool CanShoot() const;
        bool CanBomb() const {return CanNormalBomb() || CanTerraBomb() || CanSmartBomb();}
        bool CanNormalBomb() const;
        bool CanTerraBomb() const;
        bool CanSmartBomb() const;
        double GetNormalKillper() const;
        //long GetSmartKillper() const;
        long GetMinKill() const;
        long GetInstKill() const;
        long GetNetSpeed() const;
        long GetNetInit() const;
        bool CanJumpGate() const;
        const Component * GetGate() const;
        long GetEngines() const;

        bool IsBattleTarget(HullType hc) const;
        long GetAttractiveCost(const Player * owner) const;
        double GetAccuracy(const Component & torp, const Ship * target) const;

        void ResetSeen();
        bool SeenHull(long p) const                             { return mSeenHull[p]; }
        bool SeenDesign(long p) const                   { return mSeenDesign[p]; }
        void SetSeenHull(long p, bool seen)             { mSeenHull[p] = seen; }
        void SetSeenDesign(long p, bool seen)   { mSeenDesign[p] = seen; }

        void IncrementBuilt(long number)                { mBuilt += number; }

        const Hull * GetHull() const                    { return mHull; }

        const Slot & GetSlot(int i) const       { return mSlots[i]; }

        void CopyDesign(const Ship * sd, bool IsGift);
        void Upgrade(const Player * player);
        void SetCannotBuild(const Component * comp)     { mCannotBuild = comp; }
        const Component * GetCannotBuild() const        { return mCannotBuild; }

        friend bool operator==(const Ship & s1, const Ship & s2);

private:
        void ResetDefaults();
        std::string mName;
        long mGraphicNumber;
        bool mGift;
        deque<Slot> mSlots;
        const Hull * mHull;
        long mBuilt;                    // number of ships of this design that you've had
        long ReCost;                    // Turn phase costs were last recalculated
        void ScrapRecover(Cost & c, int number, const Planet * planet) const;

        deque<bool> mSeenDesign;        // who has seen this design this turn
        deque<bool> mSeenHull;          // who has seen this hull this turn
        
        friend class Bombing;

        const Component * mCannotBuild; // for starting ships

        static Cost mUpCost;
        // Calculated values
        Cost CVCost;                    // cost in minerals, resources, and crew(note normal rules don't have a crew cost)

        long CVFuelCapacity;
        long CVFuelGen;
        long CVMass;
        double CVTachyon;
        bool CCalcTachyon;
        long CVCargoCapacity;
        long CVArmor;
        long CVShield;
        long CVInitAdj;
        double CVSpeedBonus;
        bool CCalcSpeedBonus;
        long CVMines;
        long CVARMaxPop;
        long CVDock;

        double CVCompPower;
        bool CCalcCompPower;
        double CVJamming;
        bool CCalcJamming;
        double CVCapacitors;
        bool CCalcCapacitors;
        double CVDeflection;
        bool CCalcDeflection;

        double CVDampener;
        bool CCalcDampener;
        double CVRepairRate;
        bool CCalcRepairRate;
        long CVSafeSpeed;
        long CVMaxSpeed;
        long CVBattleSpeed;
        long CVFreeSpeed;

        long CVColonize;
        long CVRefuel;
        long CVDriverSpeed;
        long CVCountDrivers;

        long CVStealShip;
        long CVStealPlanet;

        long CVCloaking;
        long CVSweeping;
        long CVScanSpace;
        long CVScanPen;
        long CVRating;
        long CVShoot;
        long CVNormalBomb;
        long CVSmartBomb;
        long CVTerraBomb;
        long CVJumpGate;
        long CVEngines;
        
        double CVNormalKillper;
        bool CCalcNormalKillper;
        long CVMinKill;
        long CVInstKill;
        
        deque<long> CVTechLevel;
        deque<long> CVMineAmount;
        deque<double> CVFuelUsage;
        deque<bool> CalcedFuelUsage;
        deque<long> CVRadiation;
};

#endif // !defined(Ship_h)

---