Replaced MapViewState colony ship related member variable and logic with new ColonyShip Class

Author: oscar139

appOPHD/States/MapViewState.cpp

@@ -1,4 +1,5 @@
 #include "MapViewState.h"
+#include "ColonyShip.h"
 
 #include "MapViewStateHelper.h"
 
@@ -224,7 +225,6 @@ MapViewState::MapViewState(GameState& gameState, const Planet::Attributes& plane
 	mColonyShip{gameState.colonyShip()}
 {
 	setMeanSolarDistance(mPlanetAttributes.meanSolarDistance);
-	setPopulationLevel(PopulationLevel::Large);
 	ccLocation() = CcNotPlaced;
 	NAS2D::Utility<NAS2D::EventHandler>::get().windowResized().connect({this, &MapViewState::onWindowResized});
 }
@@ -250,13 +250,6 @@ MapViewState::~MapViewState()
 }
 
 
-void MapViewState::setPopulationLevel(PopulationLevel popLevel)
-{
-	mLandersColonist = static_cast<int>(popLevel);
-	mLandersCargo = 2; ///\todo This should be set based on difficulty level.
-}
-
-
 /**
  * Initialize values, the UI and set up event handling.
  */
@@ -888,8 +881,8 @@ void MapViewState::placeStructure(Tile& tile)
 		s.deploySignal().connect({this, &MapViewState::onDeployColonistLander});
 		NAS2D::Utility<StructureManager>::get().addStructure(s, tile);
 
-		--mLandersColonist;
-		if (mLandersColonist == 0)
+		mColonyShip.onDeployColonistLander();
+		if (!mColonyShip.colonistLanders())
 		{
 			clearMode();
 			resetUi();
@@ -904,8 +897,8 @@ void MapViewState::placeStructure(Tile& tile)
 		cargoLander.deploySignal().connect({this, &MapViewState::onDeployCargoLander});
 		NAS2D::Utility<StructureManager>::get().addStructure(cargoLander, tile);
 
-		--mLandersCargo;
-		if (mLandersCargo == 0)
+		mColonyShip.onDeployCargoLander();
+		if (!mColonyShip.cargoLanders())
 		{
 			clearMode();
 			resetUi();

appOPHD/States/MapViewState.h

@@ -113,8 +113,6 @@ class MapViewState : public Wrapper
 	MapViewState(GameState& gameState, const Planet::Attributes& planetAttributes, Difficulty selectedDifficulty);
 	~MapViewState() override;
 
-	void setPopulationLevel(PopulationLevel popLevel);
-
 	ReportsUiSignal::Source& showReportsUi() { return mReportsUiSignal; }
 	QuitSignal::Source& quit() { return mQuitSignal; }
 	MapChangedSignal::Source& mapChanged() { return mMapChangedSignal; }
@@ -205,7 +203,7 @@ class MapViewState : public Wrapper
 	void updateResearch();
 
 	// TURN LOGIC
-	void checkColonyShip();
+	void updateColonyShip();
 	void checkWarehouseCapacity();
 	void nextTurn();
 	void updatePopulation();
@@ -312,9 +310,6 @@ class MapViewState : public Wrapper
 
 	Morale mMorale;
 
-	int mLandersColonist = 0;
-	int mLandersCargo = 0;
-
 	int mResidentialCapacity = 0;
 
 	// POOLS

appOPHD/States/MapViewStateIO.cpp

@@ -5,6 +5,7 @@
 // ==================================================================================
 
 #include "MapViewState.h"
+#include "ColonyShip.h"
 
 #include "MapViewStateHelper.h"
 
@@ -168,8 +169,8 @@ void MapViewState::save(const std::string& filePath)
 		{{
 			{"morale", mMorale.currentMorale()},
 			{"prev_morale", mMorale.previousMorale()},
-			{"colonist_landers", mLandersColonist},
-			{"cargo_landers", mLandersCargo},
+			{"colonist_landers", mColonyShip.colonistLanders()},
+			{"cargo_landers", mColonyShip.cargoLanders()},
 			{"turn_number_of_landing", mTurnNumberOfLanding},
 			{"children", population.child},
 			{"students", population.student},
@@ -572,9 +573,6 @@ void MapViewState::readPopulation(NAS2D::Xml::XmlElement* element)
 
 		const auto dictionary = NAS2D::attributesToDictionary(*element);
 
-		mLandersColonist = dictionary.get<int>("colonist_landers");
-		mLandersCargo = dictionary.get<int>("cargo_landers");
-
 		mMorale = Morale(dictionary.get<int>("morale"), dictionary.get<int>("prev_morale"));
 
 		mTurnNumberOfLanding = dictionary.get<int>("turn_number_of_landing", constants::ColonyShipOrbitTime);

appOPHD/States/MapViewStateTurn.cpp

@@ -3,6 +3,8 @@
 // ==================================================================================
 
 #include "MapViewState.h"
+#include "ColonyShip.h"
+
 #include "MapViewStateHelper.h"
 
 #include "Route.h"
@@ -418,29 +420,16 @@ void MapViewState::updateResources()
  * Check for colony ship deorbiting; if any colonists are remaining, kill
  * them and reduce morale by an appropriate amount.
  */
-void MapViewState::checkColonyShip()
+void MapViewState::updateColonyShip()
 {
-	if (mTurnCount == constants::ColonyShipOrbitTime)
+	ColonyShip::ColonyShipUpdate update = mColonyShip.updateColonyShip(mDifficulty);
+	if (update)
 	{
-		if (mLandersColonist > 0 || mLandersCargo > 0)
-		{
-			mMorale.journalMoraleChange({"Deorbit Disaster!", -(mLandersColonist * 50) * ColonyShipDeorbitMoraleLossMultiplier.at(mDifficulty)});
-
-			mLandersColonist = 0;
-			mLandersCargo = 0;
-
-			populateStructureMenu();
-
-			mWindowStack.bringToFront(&mAnnouncement);
-			mAnnouncement.announcement(MajorEventAnnouncement::AnnouncementType::ColonyShipCrashWithColonists);
-			mAnnouncement.show();
-		}
-		else
-		{
-			mWindowStack.bringToFront(&mAnnouncement);
-			mAnnouncement.announcement(MajorEventAnnouncement::AnnouncementType::ColonyShipCrash);
-			mAnnouncement.show();
-		}
+		ColonyShip::ColonyShipCrashEffects crashEffects = update.value();
+		mMorale.journalMoraleChanges(crashEffects.moraleChangeEntries);
+		mWindowStack.bringToFront(&mAnnouncement);
+		mAnnouncement.announcement(crashEffects.announcementType);
+		mAnnouncement.show();
 	}
 }
 
@@ -783,13 +772,13 @@ void MapViewState::nextTurn()
 	populateRobotMenu();
 	populateStructureMenu();
 
-	checkColonyShip();
+	updateColonyShip();
 	checkWarehouseCapacity();
 
 	mMineOperationsWindow.updateTruckAvailability();
 
 	// Check for Game Over conditions
-	if (mPopulation.getPopulations().size() <= 0 && mLandersColonist == 0)
+	if (mPopulation.getPopulations().size() <= 0 && !mColonyShip.colonistLanders())
 	{
 		hideUi();
 		mGameOverDialog.show();

appOPHD/States/MapViewStateUi.cpp

@@ -5,6 +5,7 @@
 // ==================================================================================
 
 #include "MapViewState.h"
+#include "ColonyShip.h"
 #include "MapViewStateHelper.h"
 
 #include "MainMenuState.h"
@@ -335,8 +336,8 @@ void MapViewState::populateStructureMenu()
 		fillList(mConnections, mStructureTracker.surfaceTubes());
 
 		// Special case code, not thrilled with this
-		if (mLandersColonist > 0) { mStructures.addItem({constants::ColonistLander, 2, StructureID::SID_COLONIST_LANDER}); }
-		if (mLandersCargo > 0) { mStructures.addItem({constants::CargoLander, 1, StructureID::SID_CARGO_LANDER}); }
+		if (mColonyShip.colonistLanders()) { mStructures.addItem({constants::ColonistLander, 2, StructureID::SID_COLONIST_LANDER}); }
+		if (mColonyShip.cargoLanders()) { mStructures.addItem({constants::CargoLander, 1, StructureID::SID_CARGO_LANDER}); }
 	}
 	else
 	{