RacialTrait.cpp

/*
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
*/

#include "FSServer.h"


//#pragma warning(disable : 4786)       // identifier was truncated to '255' characters in the debug information
#include "RacialTrait.h"

#include "Hull.h"

#ifdef _DEBUG
#define new DEBUG_NEW
#endif

RacialTrait::RacialTrait()
{
        mGroundAttackFactor = 1.0;
        mGroundDefenseFactor = 1.0;
        mGrowthRateFactor = 1.0;
        mPopulationFactor = 1.0;
        mInherentCloakHull = HC_NONE;
        mInherentCloakAmount = 0;
        mCloakCargo = false;
        mMineSpeedBonus = 0;
        mSpyTechBonus = 0.0;
        mBattleSpeedBonus = 0.0;
        mPermaformChance = 0.0;
        mCanSeeHabSettings = false;
        mTemporaryTerraform = false;
        mScanDesign = false;
        mRepairFactor = 1.0;
        mFreighterReproduction = 0.0;
        mMineFieldScanning = false;
        mCanRemoteDetonate = false;
        mMineDecayFactor = 1.0;

        mPacketTerraform = false;
        mPacketScanning = false;
        mPacketCostMinFactor = 1.1;     // Default 10% penalty to minerals in packets
        mPacketSizeOneMin = 100;
        mPacketSizeMixed = 40;
        mPacketCostResources = 10;
        mPacketDecayFactor = 1.0;
        mPacketCatchFactor = 1.0;

        mStartAtBonus = 3;
        mSecondPlanet = false;
        mGateCargo = false;
        mOvergateLossFactor = 1.0;
        mGateScanning = false;
        mARTechType = -1;
        mFuelFactor = 1.0;
        mGeneralResearch = false;
        mUltimateRecycle = false;
        mEngineFailureSpeed = Rules::GetConstant("MaxSpeed");
        mEngineFailureRate = 0.0;
        mSpaceScanFactor = 1.0;
        mPenScanFactor = 1.0;   // mostly not used, normally only applies to AR builtin scanning
        mStartingPopFactor = 1.0;
        mMaxMiniturize = 0.75;
        mMiniturizeRate = 0.04;
        mZeroTechCost = 1.0;
        mShieldFactor = 1.0;
        mArmorFactor = 1.0;
        mShieldRegenRate = 0.0;
        mStartingTech.insert(mStartingTech.begin(), Rules::MaxTechType, 0);

        mBISHull = HC_NONE;
        mBISHullPen = HC_NONE;
        mBISTech = -1;
        mBISMultiplier = 0;
        mBISCheckPenFactor = false;
        mBISPopFactor = 0.0;

        mDefenseFactor = 1.0;
}

RacialTrait::~RacialTrait()
{
        int i;
        for (i = 0; i < mShipDesigns.size(); ++i)
                delete mShipDesigns[i];
}

// Builtin scanning -- JOAT and AR in base rules
long RacialTrait::BuiltinScan(const Player * player, HullType hc, bool PenScan, long pop /*= 0*/) const
{
        long Scan = 0;
        if (mBISPopFactor > 0.0) {
                // AR scanning: Dependant on population
                if (hc & mBISHull) {
                        Scan = long(sqrt(pop * mBISPopFactor));
                        if (PenScan) {
                                Scan /= 2;
                                if (mBISCheckPenFactor)
                                        Scan = long(Scan * PenScanFactor());
                                if (!(hc & mBISHullPen))
                                        Scan = 0;
                        }
                }
        } else if (mBISTech >= 0) {
                // JOAT scanning: Dependant on tech and multiplier
                if (hc & mBISHull) {
                        Scan = player->GetTechLevel(mBISTech) * mBISMultiplier;
                        if (PenScan) {
                                Scan /= 2;
                                if (mBISCheckPenFactor)
                                        Scan = long(Scan * PenScanFactor());
                                if (!(hc & mBISHullPen))
                                        Scan = 0;
                        }
                }
        }

        return Scan;
}

double RacialTrait::ComponentCostFactor(ComponentType ct) const
{
        deque<ComponentType>::const_iterator iter;
        iter = find(mComponentCostType.begin(), mComponentCostType.end(), ct);
        if (iter != mComponentCostType.end()) {
                return mComponentCostFactor[iter - mComponentCostType.begin()];
        } else
                return 1.0;
}

void RacialTrait::ParseStartShips(const TiXmlNode * node)
{
        const TiXmlNode * child1;
        for (child1 = node->FirstChild("ShipDesign"); child1; child1 = child1->NextSibling("ShipDesign")) {
                Ship * sd = new Ship();
                sd->SetCannotBuild(TheGame->ParseComponent(GetString(child1->FirstChild("IfCannotBuild"))));
                if (sd->ParseNode(child1, NULL, false)) {
                        mShipDesigns.insert(mShipDesigns.end(), sd);
                        mShipCounts.insert(mShipCounts.end(), GetLong(child1->FirstChild("ShipCount")));
                        mShip2ndCounts.insert(mShip2ndCounts.end(), GetLong(child1->FirstChild("SecondPlanet")));
                } else
                        delete sd;
        }
}

RacialTrait * RacialTrait::ParseNode(const TiXmlNode * node)
{
        RacialTrait * rt = new RacialTrait();

        const TiXmlNode * child1;
        const TiXmlNode * child2;
        const char * ptr;

        for (child1 = node->FirstChild(); child1; child1 = child1->NextSibling()) {
                if (child1->Type() == TiXmlNode::COMMENT)
                        continue;

                if (stricmp(child1->Value(), "Name") == 0) {
                        ptr = GetString(child1);
                        if (ptr != NULL)
                                rt->mName = ptr;
                } else if (stricmp(child1->Value(), "Cost") == 0) {
                        // Skip cost for now
                } else if (stricmp(child1->Value(), "ShipDesign") == 0) {
                        // Ship desgns are read after components are loaded, so skip for now
                } else if (stricmp(child1->Value(), "GroundAttackFactor") == 0) {
                        rt->mGroundAttackFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "GroundDefenseFactor") == 0) {
                        rt->mGroundDefenseFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "GrowthRateFactor") == 0) {
                        rt->mGrowthRateFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "PopulationFactor") == 0) {
                        rt->mPopulationFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "InherentCloaking") == 0) {
                        child2 = child1->FirstChild("HullType");
                        rt->mInherentCloakHull = Component::ParseHullType(GetString(child2));
                        child2 = child1->FirstChild("Cloaking");
                        rt->mInherentCloakAmount = GetLong(child2);
                } else if (stricmp(child1->Value(), "CloakCargo") == 0) {
                        rt->mCloakCargo = GetBool(child1);
                } else if (stricmp(child1->Value(), "MineSpeedBonus") == 0) {
                        rt->mMineSpeedBonus = GetLong(child1);
                } else if (stricmp(child1->Value(), "SpyTechBonus") == 0) {
                        rt->mSpyTechBonus = GetDouble(child1, 0.0);
                } else if (stricmp(child1->Value(), "BattleSpeedBonus") == 0) {
                        rt->mBattleSpeedBonus = GetDouble(child1, 0.0);
                } else if (stricmp(child1->Value(), "ComponentCostFactor") == 0) {
                        child2 = child1->FirstChild("ComponentType");
                        rt->mComponentCostType.insert(rt->mComponentCostType.end(), Component::ParseCompType(GetString(child2)));
                        child2 = child1->FirstChild("CostFactor");
                        rt->mComponentCostFactor.insert(rt->mComponentCostFactor.end(), GetDouble(child2, 1.0));
                } else if (stricmp(child1->Value(), "PermaformChance") == 0) {
                        rt->mPermaformChance = GetDouble(child1, 0.0);
                } else if (stricmp(child1->Value(), "CanSeeHabSettings") == 0) {
                        rt->mCanSeeHabSettings = GetBool(child1);
                } else if (stricmp(child1->Value(), "TemporaryTerraform") == 0) {
                        rt->mTemporaryTerraform = GetBool(child1);
                } else if (stricmp(child1->Value(), "ScanDesign") == 0) {
                        rt->mScanDesign = GetBool(child1);
                } else if (stricmp(child1->Value(), "RepairFactor") == 0) {
                        rt->mRepairFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "FreighterReproduction") == 0) {
                        rt->mFreighterReproduction = GetDouble(child1, 0.0);
                } else if (stricmp(child1->Value(), "MineFieldScanning") == 0) {
                        rt->mMineFieldScanning = GetBool(child1);
                } else if (stricmp(child1->Value(), "CanRemoteDetonate") == 0) {
                        rt->mCanRemoteDetonate = GetBool(child1);
                } else if (stricmp(child1->Value(), "MineDecayFactor") == 0) {
                        rt->mMineDecayFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "PacketTerraform") == 0) {
                        rt->mPacketTerraform = GetBool(child1);
                } else if (stricmp(child1->Value(), "PacketScanning") == 0) {
                        rt->mPacketScanning = GetBool(child1);
                } else if (stricmp(child1->Value(), "PacketCostMinFactor") == 0) {
                        rt->mPacketCostMinFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "PacketSizeOneMin") == 0) {
                        rt->mPacketSizeOneMin = GetLong(child1, 100);
                } else if (stricmp(child1->Value(), "PacketSizeMixed") == 0) {
                        rt->mPacketSizeMixed = GetLong(child1, 40);
                } else if (stricmp(child1->Value(), "PacketCostResources") == 0) {
                        rt->mPacketCostResources = GetLong(child1, 10);
                } else if (stricmp(child1->Value(), "PacketDecayFactor") == 0) {
                        rt->mPacketDecayFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "PacketCatchFactor") == 0) {
                        rt->mPacketCatchFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "PacketDecayPenalty") == 0) {
                        rt->mPacketDecayPenalty = GetLong(child1);

                } else if (stricmp(child1->Value(), "StartingTech") == 0) {
                        Rules::ParseArray(child1, rt->mStartingTech, TECHS);
                } else if (stricmp(child1->Value(), "StartAtBonus") == 0) {
                        rt->mStartAtBonus = GetLong(child1, 3);
                } else if (stricmp(child1->Value(), "SecondPlanet") == 0) {
                        rt->mSecondPlanet = GetBool(child1);
                } else if (stricmp(child1->Value(), "GateCargo") == 0) {
                        rt->mGateCargo = GetBool(child1);
                } else if (stricmp(child1->Value(), "OvergateLossFactor") == 0) {
                        rt->mOvergateLossFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "GateScanning") == 0) {
                        rt->mGateScanning = GetBool(child1);
                } else if (stricmp(child1->Value(), "ARTechType") == 0) {
                        rt->mARTechType = Rules::TechID(GetString(child1));
                        if (rt->mARTechType < 0) {
                                rt->mARTechType = 0;
                                TheGame->AddMessage("Invalid AR Tech Type");
                        }
                } else if (stricmp(child1->Value(), "FuelFactor") == 0) {
                        rt->mFuelFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "GeneralResearch") == 0) {
                        rt->mGeneralResearch = GetBool(child1);
                } else if (stricmp(child1->Value(), "UltimateRecycle") == 0) {
                        rt->mUltimateRecycle = GetBool(child1);
                } else if (stricmp(child1->Value(), "EngineFailureSpeed") == 0) {
                        rt->mEngineFailureSpeed = GetLong(child1, 0);
                } else if (stricmp(child1->Value(), "EngineFailureRate") == 0) {
                        rt->mEngineFailureRate = GetDouble(child1, 0.0);
                } else if (stricmp(child1->Value(), "SpaceScanFactor") == 0) {
                        rt->mSpaceScanFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "PenScanFactor") == 0) {
                        rt->mPenScanFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "StartingPopFactor") == 0) {
                        rt->mStartingPopFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "MaxMiniturize") == 0) {
                        rt->mMaxMiniturize = GetDouble(child1, 0.75);
                } else if (stricmp(child1->Value(), "MiniturizeRate") == 0) {
                        rt->mMiniturizeRate = GetDouble(child1, 0.04);
                } else if (stricmp(child1->Value(), "ZeroTechCost") == 0) {
                        rt->mZeroTechCost = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "ShieldFactor") == 0) {
                        rt->mShieldFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "ArmorFactor") == 0) {
                        rt->mArmorFactor = GetDouble(child1, 1.0);
                } else if (stricmp(child1->Value(), "ShieldRegenRate") == 0) {
                        rt->mShieldRegenRate = GetDouble(child1, 0.0);
                } else if (stricmp(child1->Value(), "BuiltInScan") == 0) {
                        child2 = child1->FirstChild("HullType");
                        rt->mBISHull = Component::ParseHullType(GetString(child2));
                        child2 = child1->FirstChild("PenScanHullType");
                        rt->mBISHullPen = Component::ParseHullType(GetString(child2));
                        child2 = child1->FirstChild("TechType");
                        rt->mBISTech = GetLong(child2, -1);
                        child2 = child1->FirstChild("Multiplier");
                        rt->mBISMultiplier = GetLong(child2, 20);
                        child2 = child1->FirstChild("CheckPenFactor");
                        rt->mBISCheckPenFactor = GetBool(child2);
                        child2 = child1->FirstChild("PopFactor");
                        rt->mBISPopFactor = GetDouble(child2, 0.0);
                } else if (stricmp(child1->Value(), "DefenseFactor") == 0) {
                        rt->mDefenseFactor = GetDouble(child1, 1.0);
                } else {
                        Message * mess = TheGame->AddMessage("Warning: Unknown section");
                        mess->AddItem("Racial trait", rt->mName);
                        mess->AddItem("Section", child1->Value());
                        continue;
                }
        }

        return rt;
}

---