Wormhole.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(Wormhole_h)
#define Wormhole_h
#include <deque>
using namespace std;
class Location;

const long WORM_IMMOBILE        = 0;    // will never shift
const long WORM_VERYSTABLE      = 1;
const long WORM_STABLE          = 2;
const long WORM_AVERAGE         = 3;
const long WORM_UNSTABLE        = 4;
const long WORM_VERYUNSTABLE= 5;
const long WORM_WILLJUMP        = 100;  // will jump next year

class Wormhole : public CargoHolder
{
public:
        Wormhole();
//      Wormhole(const Location & end)
//              : CargoHolder(), mStability(WORM_VERYSTABLE), mMaxStability(WORM_VERYSTABLE), mMinStability(WORM_VERYUNSTABLE)
//              {  Init(); SetLocation(end); mID = TheGalaxy->GetWormholeID(); }
        Wormhole(const Wormhole & hole);
        void Init();

        virtual long GetCloak(const Player * p, bool pen) const {
                return (pen || mHadSeen[p->GetID()-1]) ? 0 : Rules::GetConstant("WormholeCloak", 75); }
        virtual long GetCargoCapacity() const   { return 0; }
        virtual double GetMaxTachyon() const    { return 1.0; }
        virtual long GetScanPen() const                 { return -1; }
        virtual long GetScanSpace() const               { return -1; }
        virtual bool CanLoadBy(const Player *) const    { return false; }
        virtual void SetCanLoadBy(const Player *)               {}

        bool ParseNode(const TiXmlNode * node);
        virtual TiXmlNode * WriteNode(TiXmlNode * node, const Player * viewer) const;
        long GetStability() const                               { return mStability; }
        const Wormhole * GetAttached() const;
        void SetAttached(const Wormhole * wh)   { mAttached = wh; mAttachedID = wh ? wh->GetID() : 0; }
        void Enter(long id) const;
        void Exit(long id) const;
        void AdjustTraverse();
        void Jiggle();
        void Shift();

private:
        void AvoidPlanets();
        const Wormhole * mAttached;
        long mAttachedID;
        long mStability;
        long mMaxStability;     // the most stable this wormhole can get (WORM_VERYSTABLE is default)
        long mMinStability;     // the most unstable this wormhole can get (WORM_VERYUNSTABLE is default)
        deque<bool> mHadSeen;
        deque<bool> mTraversed;
};

#endif // Wormhole_h

---