Merge pull request #1509 from OutpostUniverse/Refactor/Morale_Change_Reasons

DanRStevens · web-flow · commit e341033f7b21 · 2025-01-13T10:04:34.000-07:00
Refactor/morale change reasons
diff --git a/OPHD/States/MapViewStateIO.cpp b/OPHD/States/MapViewStateIO.cpp
@@ -182,7 +182,7 @@ void MapViewState::save(const std::string& filePath)
 	));
 
 	auto moraleChangeReasons = new NAS2D::Xml::XmlElement("morale_change");
-	auto& moraleChangeList = mPopulationPanel.moraleReasonList();
+	auto& moraleChangeList = mMorale.moraleChangeJournal();
 	for (auto& [message, value] : moraleChangeList)
 	{
 		moraleChangeReasons->linkEndChild(NAS2D::dictionaryToAttributes(
@@ -229,7 +229,7 @@ void MapViewState::load(const std::string& filePath)
 	mBtnToggleRouteOverlay.toggle(false);
 	mBtnTogglePoliceOverlay.toggle(false);
 	mBtnToggleHeightmap.toggle(false);
-	mPopulationPanel.clearMoraleReasons();
+	mMorale.closeJournal();
 
 	if (!NAS2D::Utility<NAS2D::Filesystem>::get().exists(filePath))
 	{
@@ -596,6 +596,6 @@ void MapViewState::readMoraleChanges(NAS2D::Xml::XmlElement* moraleChangeElement
 		const auto message = dictionary.get("message");
 		const auto val = dictionary.get<int>("val");
 
-		mPopulationPanel.addMoraleReason(message, val);
+		mMorale.journalMoraleChange({message, val});
 	}
 }
diff --git a/OPHD/States/MapViewStateTurn.cpp b/OPHD/States/MapViewStateTurn.cpp
@@ -171,7 +171,7 @@ void MapViewState::updateCommercial()
 		}
 	}
 
-	mMorale.adjustMorale(commercialCount - luxuryCount);
+	mMorale.journalMoraleChange({"Commercial - Luxury", commercialCount - luxuryCount});
 }
 
 
@@ -203,43 +203,30 @@ void MapViewState::updateMorale()
 	}
 
 	// positive
-	mMorale.adjustMorale(birthCount);
-	mMorale.adjustMorale(parkCount);
-	mMorale.adjustMorale(recreationCount);
-	mMorale.adjustMorale(commercialCount);
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::Births), birthCount});
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::Parks), parkCount});
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::Recreation), recreationCount});
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::Commercial), commercialCount});
 
 	// negative
-	mMorale.adjustMorale(-deathCount);
-	mMorale.adjustMorale(-residentialOverCapacityHit);
-	mMorale.adjustMorale(-bioWasteAccumulation * 2);
-	mMorale.adjustMorale(-structuresDisabled);
-	mMorale.adjustMorale(-structuresDestroyed);
-	mMorale.adjustMorale(-foodProductionHit);
-
-	mPopulationPanel.clearMoraleReasons();
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::Births), birthCount);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::Deaths), -deathCount);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::NoFoodProduction), -foodProductionHit);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::Parks), parkCount);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::Recreation), recreationCount);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::Commercial), commercialCount);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::ResidentialOverflow), -residentialOverCapacityHit);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::BiowasteOverflow), bioWasteAccumulation * -2);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::StructuresDisabled), -structuresDisabled);
-	mPopulationPanel.addMoraleReason(moraleString(MoraleIndexs::StructuresDestroyed), -structuresDestroyed);
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::Deaths), -deathCount});
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::ResidentialOverflow), -residentialOverCapacityHit});
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::BiowasteOverflow), -bioWasteAccumulation * 2}); // TODO 2 is a magic number
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::StructuresDisabled), -structuresDisabled});
+	mMorale.journalMoraleChange({moraleString(MoraleIndexs::StructuresDestroyed), -structuresDestroyed});
+	mMorale.journalMoraleChange({"Food Production Issues", -foodProductionHit});
+
 
 	for (const auto& moraleReason : mCrimeRateUpdate.moraleChanges())
 	{
-		mPopulationPanel.addMoraleReason(moraleReason.first, moraleReason.second);
-		mMorale.adjustMorale(moraleReason.second);
+		mMorale.journalMoraleChange({moraleReason.first, moraleReason.second});
 	}
 
 	mPopulationPanel.crimeRate(mCrimeRateUpdate.meanCrimeRate());
 
 	for (const auto& moraleReason : mCrimeExecution.moraleChanges())
 	{
-		mPopulationPanel.addMoraleReason(moraleReason.first, moraleReason.second);
-		mMorale.adjustMorale(moraleReason.second);
+		mMorale.journalMoraleChange({moraleReason.first, moraleReason.second});
 	}
 }
 
@@ -380,7 +367,7 @@ void MapViewState::checkColonyShip()
 	{
 		if (mLandersColonist > 0 || mLandersCargo > 0)
 		{
-			mMorale.adjustMorale(-(mLandersColonist * 50) * ColonyShipDeorbitMoraleLossMultiplier.at(mDifficulty));
+			mMorale.journalMoraleChange({"Deorbit Disaster!", -(mLandersColonist * 50) * ColonyShipDeorbitMoraleLossMultiplier.at(mDifficulty)});
 
 			mLandersColonist = 0;
 			mLandersCargo = 0;
@@ -695,6 +682,8 @@ void MapViewState::nextTurn()
 	mNotificationWindow.hide();
 	mNotificationArea.clear();
 
+	mMorale.closeJournal();
+
 	clearMode();
 
 	mPopulationPool.clear();
diff --git a/OPHD/UI/PopulationPanel.cpp b/OPHD/UI/PopulationPanel.cpp
@@ -93,12 +93,6 @@ PopulationPanel::PopulationPanel(const Population& pop, const PopulationPool& po
 	size({windowWidth, windowHeight});
 }
 
-void PopulationPanel::addMoraleReason(const std::string& str, int val)
-{
-	if (val == 0) { return; }
-	mMoraleChangeReasons.push_back(std::make_pair(str, val));
-}
-
 
 void PopulationPanel::update()
 {
@@ -187,14 +181,15 @@ void PopulationPanel::update()
 
 	position.y += constants::Margin;
 
-	for (auto& item : mMoraleChangeReasons)
+	for (auto& entry : mMorale.moraleChangeJournal())
 	{
-		renderer.drawText(mFont, item.first, position);
+		if (entry.value == 0) { continue; }
+		renderer.drawText(mFont, entry.description , position);
 
-		const auto text = formatDiff(item.second);
+		const auto text = formatDiff(entry.value);
 		const NAS2D::Point<int> labelPosition = {rect().position.x + rect().size.x - mFont.width(text) - 5 , position.y};
 
-		renderer.drawText(mFont, text, labelPosition, trend[trendIndex(item.second)]);
+		renderer.drawText(mFont, text, labelPosition, trend[trendIndex(entry.value)]);
 		position.y += fontHeight;
 	}
 }
diff --git a/OPHD/UI/PopulationPanel.h b/OPHD/UI/PopulationPanel.h
@@ -28,13 +28,6 @@ class PopulationPanel : public Control
 
 	void crimeRate(int val) { mCrimeRate = val; }
 	int crimeRate() const { return mCrimeRate; }
-
-	void addMoraleReason(const std::string& str, int val);
-
-	const auto& moraleReasonList() const { return mMoraleChangeReasons; }
-
-	void clearMoraleReasons() { mMoraleChangeReasons.clear(); }
-
 	void update() override;
 
 private:
diff --git a/libOPHD/Population/Morale.cpp b/libOPHD/Population/Morale.cpp
@@ -30,15 +30,32 @@ int Morale::previousMorale() const
 }
 
 
-void Morale::adjustMorale(int diff)
+void Morale::journalMoraleChange(const MoraleChangeEntry& entry)
 {
-	mMoraleAccumulator += diff;
+	mMoraleChangeJournal.push_back(entry);
+}
+
+const std::vector<MoraleChangeEntry>& Morale::moraleChangeJournal() const
+{
+	return mMoraleChangeJournal;
+}
+
+
+void Morale::closeJournal()
+{
+	mMoraleChangeJournal.clear();
 }
 
 
 void Morale::commitMoraleChanges()
 {
 	mPreviousMorale = currentMorale();
+
+	for (const auto& entry : mMoraleChangeJournal)
+	{
+		mMoraleAccumulator += entry.value;
+	}
+
 	mCurrentMorale = std::clamp(mCurrentMorale + mMoraleAccumulator, 0, constants::MaximumMorale);
 	mMoraleAccumulator = 0;
 }
diff --git a/libOPHD/Population/Morale.h b/libOPHD/Population/Morale.h
@@ -1,6 +1,8 @@
 #pragma once
 
 #include <cstdint>
+#include <vector>
+#include <string>
 
 /**
  * Morale modifier values.
@@ -13,14 +15,24 @@ struct MoraleModifier
 	int mortalityRate{0};
 };
 
+struct MoraleChangeEntry
+{
+	std::string description{};
+	int value{0};
+};
+
 class Morale
 {
 public:
 	Morale();
 	Morale(int currentMorale, int previousMorale);
 	int currentMorale() const;
 	int previousMorale() const;
-	void adjustMorale(int diff);
+	void journalMoraleChange(const MoraleChangeEntry& entry);
+	const std::vector<MoraleChangeEntry>& moraleChangeJournal() const;
+
+	// Clears the morale change journal vector of all entries
+	void closeJournal();
 
 	// Should be called after all morale calculations are done for the turn to apply the morale changes but before its needed to update the UI
 	void commitMoraleChanges();
@@ -30,4 +42,5 @@ class Morale
 	int mCurrentMorale;
 	int mPreviousMorale;
 	int mMoraleAccumulator;
+	std::vector<MoraleChangeEntry> mMoraleChangeJournal;
 };

Original file line number	Diff line number	Diff line change
`@@ -182,7 +182,7 @@ void MapViewState::save(const std::string& filePath)`
`182`	`182`	`));`
`183`	`183`
`184`	`184`	`auto moraleChangeReasons = new NAS2D::Xml::XmlElement("morale_change");`
`185`		`- auto& moraleChangeList = mPopulationPanel.moraleReasonList();`
	`185`	`+ auto& moraleChangeList = mMorale.moraleChangeJournal();`
`186`	`186`	`for (auto& [message, value] : moraleChangeList)`
`187`	`187`	`{`
`188`	`188`	`moraleChangeReasons->linkEndChild(NAS2D::dictionaryToAttributes(`
`@@ -229,7 +229,7 @@ void MapViewState::load(const std::string& filePath)`
`229`	`229`	`mBtnToggleRouteOverlay.toggle(false);`
`230`	`230`	`mBtnTogglePoliceOverlay.toggle(false);`
`231`	`231`	`mBtnToggleHeightmap.toggle(false);`
`232`		`- mPopulationPanel.clearMoraleReasons();`
	`232`	`+ mMorale.closeJournal();`
`233`	`233`
`234`	`234`	`if (!NAS2D::Utility<NAS2D::Filesystem>::get().exists(filePath))`
`235`	`235`	`{`
`@@ -596,6 +596,6 @@ void MapViewState::readMoraleChanges(NAS2D::Xml::XmlElement* moraleChangeElement`
`596`	`596`	`const auto message = dictionary.get("message");`
`597`	`597`	`const auto val = dictionary.get<int>("val");`
`598`	`598`
`599`		`- mPopulationPanel.addMoraleReason(message, val);`
	`599`	`+ mMorale.journalMoraleChange({message, val});`
`600`	`600`	`}`
`601`	`601`	`}`
Original file line number	Diff line number	Diff line change
`@@ -93,12 +93,6 @@ PopulationPanel::PopulationPanel(const Population& pop, const PopulationPool& po`
`93`	`93`	`size({windowWidth, windowHeight});`
`94`	`94`	`}`
`95`	`95`
`96`		`-void PopulationPanel::addMoraleReason(const std::string& str, int val)`
`97`		`-{`
`98`		`- if (val == 0) { return; }`
`99`		`- mMoraleChangeReasons.push_back(std::make_pair(str, val));`
`100`		`-}`
`101`		`-`
`102`	`96`
`103`	`97`	`void PopulationPanel::update()`
`104`	`98`	`{`
`@@ -187,14 +181,15 @@ void PopulationPanel::update()`
`187`	`181`
`188`	`182`	`position.y += constants::Margin;`
`189`	`183`
`190`		`- for (auto& item : mMoraleChangeReasons)`
	`184`	`+ for (auto& entry : mMorale.moraleChangeJournal())`
`191`	`185`	`{`
`192`		`- renderer.drawText(mFont, item.first, position);`
	`186`	`+ if (entry.value == 0) { continue; }`
	`187`	`+ renderer.drawText(mFont, entry.description , position);`
`193`	`188`
`194`		`- const auto text = formatDiff(item.second);`
	`189`	`+ const auto text = formatDiff(entry.value);`
`195`	`190`	`const NAS2D::Point<int> labelPosition = {rect().position.x + rect().size.x - mFont.width(text) - 5 , position.y};`
`196`	`191`
`197`		`- renderer.drawText(mFont, text, labelPosition, trend[trendIndex(item.second)]);`
	`192`	`+ renderer.drawText(mFont, text, labelPosition, trend[trendIndex(entry.value)]);`
`198`	`193`	`position.y += fontHeight;`
`199`	`194`	`}`
`200`	`195`	`}`