Merge branch 'includePrimeStateInSavedLayout' of https://github.com/fenyo1/OpenXcom into fenyo1-includePrimeStateInSavedLayout

Author: Warboy1982

bin/data/Language/en-GB.yml

@@ -1310,3 +1310,5 @@ en-GB:
   STR_DISPLAY_OPTIONS_CONFIRM: "Do you want to keep the current display options?"
   STR_DISPLAY_OPTIONS_REVERT: "Reverting in 0:{0}"
   STR_MISSING_CONTENT_PROMPT: "WARNING:{SMALLLINE}This save relies on mods that are unavailable. Missing content will be removed, and it may fail to load.{NEWLINE}Continue?"
+  STR_INCLUDE_PRIMESTATE_IN_SAVED_LAYOUT: "Include prime-state in the saved equipment-layout"
+  STR_INCLUDE_PRIMESTATE_IN_SAVED_LAYOUT_DESC: "Save and load back the prime-states of the grenades in the equipment-layouts along with the items."

bin/data/Language/en-US.yml

@@ -1310,3 +1310,5 @@ en-US:
   STR_DISPLAY_OPTIONS_CONFIRM: "Do you want to keep the current display options?"
   STR_DISPLAY_OPTIONS_REVERT: "Reverting in 0:{0}"
   STR_MISSING_CONTENT_PROMPT: "WARNING:{SMALLLINE}This save relies on mods that are unavailable. Missing content will be removed, and it may fail to load.{NEWLINE}Continue?"
+  STR_INCLUDE_PRIMESTATE_IN_SAVED_LAYOUT: "Include prime-state in the saved equipment-layout"
+  STR_INCLUDE_PRIMESTATE_IN_SAVED_LAYOUT_DESC: "Save and load back the prime-states of the grenades in the equipment-layouts along with the items."

src/Battlescape/BattlescapeGenerator.cpp

@@ -884,6 +884,7 @@ bool BattlescapeGenerator::placeItemByLayout(BattleItem *item)
 					item->setSlot(_game->getRuleset()->getInventory((*j)->getSlot()));
 					item->setSlotX((*j)->getSlotX());
 					item->setSlotY((*j)->getSlotY());
+					if (Options::includePrimeStateInSavedLayout) item->setFuseTimer((*j)->getFuseTimer());
 					_save->getItems()->push_back(item);
 					return true;
 				}

src/Battlescape/Inventory.cpp

@@ -682,7 +682,7 @@ void Inventory::mouseClick(Action *action, State *state)
 	{
 		if (_selItem == 0)
 		{
-			if (!_base)
+			if (!_base || Options::includePrimeStateInSavedLayout)
 			{
 				if (!_tu)
 				{

src/Battlescape/InventoryState.cpp

@@ -340,7 +340,8 @@ void InventoryState::saveEquipmentLayout()
 				(*j)->getSlot()->getId(),
 				(*j)->getSlotX(),
 				(*j)->getSlotY(),
-				ammo
+				ammo,
+				(*j)->getFuseTimer()
 			));
 		}
 	}

src/Engine/Options.cpp

@@ -127,6 +127,7 @@ void create()
 	_info.push_back(OptionInfo("globeScrollDragButton", &globeScrollDragButton, SDL_BUTTON_MIDDLE));
 
 	// advanced options
+	_info.push_back(OptionInfo("includePrimeStateInSavedLayout", &includePrimeStateInSavedLayout, false, "STR_INCLUDE_PRIMESTATE_IN_SAVED_LAYOUT", "STR_BATTLESCAPE"));
 	_info.push_back(OptionInfo("playIntro", &playIntro, true, "STR_PLAYINTRO", "STR_GENERAL"));
 	_info.push_back(OptionInfo("autosave", &autosave, 0, "STR_AUTOSAVE", "STR_GENERAL"));
 	_info.push_back(OptionInfo("newSeedOnLoad", &newSeedOnLoad, false, "STR_NEWSEEDONLOAD", "STR_GENERAL"));

src/Engine/Options.inc.h

@@ -16,7 +16,7 @@ OPT SDLKey keyOk, keyCancel, keyScreenshot, keyFps, keyQuickLoad, keyQuickSave;
 
 // Geoscape options
 OPT int geoClockSpeed, dogfightSpeed, globeScrollSpeed, globeScrollDragButton;
-OPT bool anytimePsiTraining, weaponSelfDestruction, spendResearchedItems, craftLaunchAlways, globeSeasons, globeDetail, globeRadarLines, globeFlightPaths, globeAllRadarsOnBaseBuild,
+OPT bool includePrimeStateInSavedLayout, anytimePsiTraining, weaponSelfDestruction, spendResearchedItems, craftLaunchAlways, globeSeasons, globeDetail, globeRadarLines, globeFlightPaths, globeAllRadarsOnBaseBuild,
 	alienContainmentLimitEnforced, canSellLiveAliens, canTransferCraftsWhileAirborne, canManufactureMoreItemsPerHour, customInitialBase, aggressiveRetaliation,
 	allowBuildingQueue, allowAutoSellProduction, showFundsOnGeoscape, psiStrengthEval;
 OPT SDLKey keyGeoLeft, keyGeoRight, keyGeoUp, keyGeoDown, keyGeoZoomIn, keyGeoZoomOut, keyGeoSpeed1, keyGeoSpeed2, keyGeoSpeed3, keyGeoSpeed4, keyGeoSpeed5, keyGeoSpeed6,

src/Savegame/EquipmentLayoutItem.cpp

@@ -27,6 +27,7 @@ namespace OpenXcom
  */
 EquipmentLayoutItem::EquipmentLayoutItem(const YAML::Node &node)
 {
+	_fuseTimer = -1; // for compatibility
 	load(node);
 }
 
@@ -37,9 +38,9 @@ EquipmentLayoutItem::EquipmentLayoutItem(const YAML::Node &node)
  * @param slotX Position-X in the occupied slot.
  * @param slotY Position-Y in the occupied slot.
  * @param ammoItem The ammo has to be loaded into the item. (it's type)
- * @param explodeTurn The turn when the item explodes. (if it's an activated grenade-type)
+ * @param fuseTimer The turn until explosion of the item. (if it's an activated grenade-type)
  */
-EquipmentLayoutItem::EquipmentLayoutItem(std::string itemType, std::string slot, int slotX, int slotY, std::string ammoItem) : _itemType(itemType), _slot(slot), _slotX(slotX), _slotY(slotY), _ammoItem(ammoItem)
+EquipmentLayoutItem::EquipmentLayoutItem(std::string itemType, std::string slot, int slotX, int slotY, std::string ammoItem, int fuseTimer) : _itemType(itemType), _slot(slot), _slotX(slotX), _slotY(slotY), _ammoItem(ammoItem), _fuseTimer(fuseTimer)
 {
 }
 
@@ -95,6 +96,15 @@ std::string EquipmentLayoutItem::getAmmoItem() const
 	return _ammoItem;
 }
 
+/**
+ * Returns the turn until explosion of the item. (if it's an activated grenade-type)
+ * @return turn count.
+ */
+int EquipmentLayoutItem::getFuseTimer() const
+{
+	return _fuseTimer;
+}
+
 /**
  * Loads the soldier-equipment layout item from a YAML file.
  * @param node YAML node.
@@ -106,6 +116,7 @@ void EquipmentLayoutItem::load(const YAML::Node &node)
 	_slotX = node["slotX"].as<int>(_slotX);
 	_slotY = node["slotY"].as<int>(_slotY);
 	_ammoItem = node["ammoItem"].as<std::string>(_ammoItem);
+	_fuseTimer = node["fuseTimer"].as<int>(_fuseTimer);
 }
 
 /**
@@ -120,6 +131,7 @@ YAML::Node EquipmentLayoutItem::save() const
 	node["slotX"] = _slotX;
 	node["slotY"] = _slotY;
 	node["ammoItem"] = _ammoItem;
+	node["fuseTimer"] = _fuseTimer;
 	return node;
 }
 

src/Savegame/EquipmentLayoutItem.h

@@ -36,11 +36,12 @@ class EquipmentLayoutItem
 	std::string _slot;
 	int _slotX, _slotY;
 	std::string _ammoItem;
+	int _fuseTimer;
 public:
 	/// Creates a new soldier-equipment layout item and loads its contents from YAML.
 	EquipmentLayoutItem(const YAML::Node& node);
 	/// Creates a new soldier-equipment layout item.
-	EquipmentLayoutItem(std::string itemType, std::string slot, int slotX, int slotY, std::string ammoItem);
+	EquipmentLayoutItem(std::string itemType, std::string slot, int slotX, int slotY, std::string ammoItem, int fuseTimer);
 	/// Cleans up the soldier-equipment layout item.
 	~EquipmentLayoutItem();
 	/// Gets the item's type which has to be in a slot
@@ -53,6 +54,8 @@ class EquipmentLayoutItem
 	int getSlotY() const;
 	/// Gets the ammo item
 	std::string getAmmoItem() const;
+	/// Gets the turn until explosion
+	int getFuseTimer() const;
 	/// Loads the soldier-equipment layout item from YAML.
 	void load(const YAML::Node& node);
 	/// Saves the soldier-equipment layout item to YAML.