Ability to define the item needed for research

MeridianOXC · Dec 29, 2023 · bfaf3ee · bfaf3ee
1 parent 8c42920
commit bfaf3ee
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 17 deletions.
diff --git a/src/Basescape/GlobalAlienContainmentState.cpp b/src/Basescape/GlobalAlienContainmentState.cpp
@@ -170,7 +170,7 @@ void GlobalAlienContainmentState::fillPrisonerList()
 			for (const auto* proj : xbase->getResearch())
 			{
 				const RuleResearch* research = proj->getRules();
-				RuleItem* item = _game->getMod()->getItem(research->getName());
+				const RuleItem* item = _game->getMod()->getItem(research->getName()); // don't use getNeededItem()
 				if (research->needItem() && research->destroyItem() && item && item->isAlien() && item->getPrisonType() == prisonType)
 				{
 					researchList.push_back(research->getName());

diff --git a/src/Basescape/ManageAlienContainmentState.cpp b/src/Basescape/ManageAlienContainmentState.cpp
@@ -214,7 +214,7 @@ void ManageAlienContainmentState::resetListAndTotals()
 	for (const auto* proj : _base->getResearch())
 	{
 		const RuleResearch *research = proj->getRules();
-		RuleItem *item = _game->getMod()->getItem(research->getName());
+		const RuleItem *item = _game->getMod()->getItem(research->getName()); // don't use getNeededItem()
 		if (research->needItem() && research->destroyItem() && item && item->isAlien() && item->getPrisonType() == _prisonType)
 		{
 			researchList.push_back(research->getName());

diff --git a/src/Basescape/ResearchInfoState.cpp b/src/Basescape/ResearchInfoState.cpp
@@ -130,7 +130,7 @@ void ResearchInfoState::buildUi()
 		_base->addResearch(_project);
 		if (_rule->needItem() && _rule->destroyItem())
 		{
-			_base->getStorageItems()->removeItem(_rule->getName(), 1);
+			_base->getStorageItems()->removeItem(_rule->getNeededItem(), 1);
 		}
 	}
 	setAssignedScientist();

diff --git a/src/Basescape/StoresState.cpp b/src/Basescape/StoresState.cpp
@@ -309,9 +309,10 @@ void StoresState::initList(bool grandTotal)
 				// 4. items/aliens in research
 				for (const auto* research : xbase->getResearch())
 				{
-					if (research->getRules()->needItem() && research->getRules()->getName() == itemType)
+					const auto* rrule = research->getRules();
+					if (rrule->needItem() && rrule->destroyItem())
 					{
-						if (research->getRules()->destroyItem())
+						if (rrule->getNeededItem() && rrule->getNeededItem()->getType() == itemType)
 						{
 							qty += 1;
 							break;

diff --git a/src/Basescape/TechTreeViewerState.cpp b/src/Basescape/TechTreeViewerState.cpp
@@ -537,12 +537,23 @@ void TechTreeViewerState::initLists()
 			_leftTopics.push_back("-");
 			_leftFlags.push_back(TTV_NONE);
 			++row;
-			std::string itemName = tr(_selectedTopic);
-			itemName.insert(0, "  ");
-			_lstLeft->addRow(1, itemName.c_str());
-			_lstLeft->setRowColor(row, getResearchColor(_selectedTopic));
-			_leftTopics.push_back(_selectedTopic);
-			_leftFlags.push_back(TTV_ITEMS);
+			if (rule->getNeededItem())
+			{
+				std::string itemName = tr(rule->getNeededItem()->getType());
+				itemName.insert(0, "  ");
+				_lstLeft->addRow(1, itemName.c_str());
+				_lstLeft->setRowColor(row, _white);
+				_leftTopics.push_back(rule->getNeededItem()->getType());
+				_leftFlags.push_back(TTV_ITEMS);
+			}
+			else
+			{
+				std::string itemName = "  -";
+				_lstLeft->addRow(1, itemName.c_str());
+				_lstLeft->setRowColor(row, _white);
+				_leftTopics.push_back("-");
+				_leftFlags.push_back(TTV_NONE);
+			}
 			++row;
 		}
 

diff --git a/src/Geoscape/GeoscapeState.cpp b/src/Geoscape/GeoscapeState.cpp
@@ -2382,7 +2382,7 @@ void GeoscapeState::time1Day()
 			// 3b. handle interrogation
 			if (Options::retainCorpses && research->needItem() && research->destroyItem())
 			{
-				auto* ruleUnit = mod->getUnit(research->getName(), false);
+				auto* ruleUnit = mod->getUnit(research->getName(), false); // don't use getNeededItem()
 				if (ruleUnit)
 				{
 					auto* ruleCorpse = ruleUnit->getArmor()->getCorpseGeoscape();

diff --git a/src/Mod/RuleResearch.cpp b/src/Mod/RuleResearch.cpp
@@ -60,6 +60,7 @@ void RuleResearch::load(const YAML::Node &node, Mod* mod, const ModScript& parse
 	mod->loadBaseFunction(_name, _requiresBaseFunc, node["requiresBaseFunc"]);
 	_sequentialGetOneFree = node["sequentialGetOneFree"].as<bool>(_sequentialGetOneFree);
 	mod->loadNamesToNames(_name, _getOneFreeProtectedName, node["getOneFreeProtected"]);
+	mod->loadNameNull(_name, _neededItemName, node["neededItem"]);
 	_needItem = node["needItem"].as<bool>(_needItem);
 	_destroyItem = node["destroyItem"].as<bool>(_destroyItem);
 	_unlockFinalMission = node["unlockFinalMission"].as<bool>(_unlockFinalMission);
@@ -82,6 +83,21 @@ void RuleResearch::afterLoad(const Mod* mod)
 		_lookup = "";
 	}
 
+	if (_needItem)
+	{
+		// FIXME: this would break all mods unfortunately, maybe one day...
+		//mod->linkRule(_neededItem, _neededItemName.empty() ? _name : _neededItemName);
+
+		if (_neededItemName.empty())
+		{
+			_neededItem = mod->getItem(_name, false); // false, because even vanilla ruleset is a mess
+		}
+		else
+		{
+			_neededItem = mod->getItem(_neededItemName, true);
+		}
+	}
+
 	_dependencies = mod->getResearch(_dependenciesName);
 	_unlocks = mod->getResearch(_unlocksName);
 	_disables = mod->getResearch(_disablesName);

diff --git a/src/Mod/RuleResearch.h b/src/Mod/RuleResearch.h
@@ -54,6 +54,8 @@ class RuleResearch
 	bool _sequentialGetOneFree;
 	std::vector<std::pair<std::string, std::vector<std::string> > > _getOneFreeProtectedName;
 	std::vector<std::pair<const RuleResearch*, std::vector<const RuleResearch*> > > _getOneFreeProtected;
+	std::string _neededItemName;
+	const RuleItem* _neededItem = nullptr;
 	bool _needItem, _destroyItem, _unlockFinalMission;
 	int _listOrder;
 
@@ -82,6 +84,8 @@ class RuleResearch
 	const std::vector<const RuleResearch*> &getDependencies() const;
 	/// Checks if this ResearchProject gives free topics in sequential order (or random order).
 	bool sequentialGetOneFree() const;
+	/// Gets the Item needed for this research.
+	const RuleItem* getNeededItem() const { return _neededItem; }
 	/// Checks if this ResearchProject needs a corresponding Item to be researched.
 	bool needItem() const;
 	/// Checks if this ResearchProject consumes the corresponding Item when research completes.

diff --git a/src/Savegame/Base.cpp b/src/Savegame/Base.cpp
@@ -1301,7 +1301,7 @@ void Base::removeResearch(ResearchProject * project)
 	{
 		if (ruleResearch->needItem() && ruleResearch->destroyItem())
 		{
-			getStorageItems()->addItem(ruleResearch->getName(), 1);
+			getStorageItems()->addItem(ruleResearch->getNeededItem(), 1);
 		}
 	}
 
@@ -1455,7 +1455,7 @@ int Base::getUsedContainment(int prisonType, bool onlyExternal) const
 		const RuleResearch *projRules = proj->getRules();
 		if (projRules->needItem() && projRules->destroyItem())
 		{
-			rule = _mod->getItem(projRules->getName());
+			rule = _mod->getItem(projRules->getName()); // don't use getNeededItem()
 			if (rule->isAlien() && rule->getPrisonType() == prisonType)
 			{
 				++total;
@@ -2060,12 +2060,12 @@ void Base::cleanupPrisons(int prisonType)
 			const RuleResearch* projRules = project->getRules();
 			if (projRules->needItem() && projRules->destroyItem())
 			{
-				RuleItem* rule = _mod->getItem(projRules->getName());
+				RuleItem* rule = _mod->getItem(projRules->getName()); // don't use getNeededItem()
 				if (rule->isAlien() && rule->getPrisonType() == prisonType)
 				{
 					_scientists += project->getAssigned();
 					project->setAssigned(0);
-					getStorageItems()->addItem(projRules->getName(), 1);
+					getStorageItems()->addItem(projRules->getNeededItem(), 1);
 					return true;
 				}
 			}

diff --git a/src/Savegame/SavedGame.cpp b/src/Savegame/SavedGame.cpp
@@ -1840,7 +1840,7 @@ void SavedGame::getAvailableResearchProjects(std::vector<RuleResearch *> &projec
 			}
 
 			// Check for needed item in the given base
-			if (research->needItem() && base->getStorageItems()->getItem(research->getName()) == 0)
+			if (research->needItem() && base->getStorageItems()->getItem(research->getNeededItem()) == 0)
 			{
 				continue;
 			}