Added sprite support

Author: Shoes01

bin/data/Ruleset/Xcom1Ruleset.rul

@@ -9285,6 +9285,20 @@ extraSprites:
     singleImage: true
     files:
       0: Resources/UI/reserve.png
+  - type: BIGOBS.PCK
+    width: 30
+    heigth: 8
+    files:
+      100: Resources/Commendations/medal_100.png
+      101: Resources/Commendations/medal_101.png
+      102: Resources/Commendations/medal_102.png
+      103: Resources/Commendations/medal_103.png
+      104: Resources/Commendations/medal_104.png
+      105: Resources/Commendations/medal_105.png
+      106: Resources/Commendations/medal_106.png
+      107: Resources/Commendations/medal_107.png
+      
+      
 # Ruleset for diary and commendations mod
 # When stats reach the criteria threshold, the commendation is awarded
 # Any vector greater than 10 will require more strings to be written for them.
@@ -9311,41 +9325,51 @@ extraSprites:
 commendations:
   - type: STR_MEDAL_MERIT_STAR_NAME
     description: STR_MEDAL_MERIT_STAR_DESCRIPTION
+    sprite: 100
     criteria: 
-      total_kills: [3, 6, 10, 15, 20, 25, 30, 35, 40, 50]
+      total_kills: [0, 6, 10, 15, 20, 25, 30, 35, 40, 50]
   - type: STR_MEDAL_MILITARY_CROSS_NAME
     description: STR_MEDAL_MILITARY_CROSS_DESCRIPTION
+    sprite: 101
     criteria:
-      total_missions: [3, 6, 10, 15, 20, 25, 30, 35, 40, 50]
+      total_missions: [0, 6, 10, 15, 20, 25, 30, 35, 40, 50]
   - type: STR_MEDAL_STAR_OF_GALLANTRY_NAME
     description: STR_MEDAL_STAR_OF_GALLANTRY_DESCRIPTION
+    sprite: 102
     criteria:
       total_stuns: [1, 3, 5, 7, 9, 11, 13, 15, 17, 20]
   - type: STR_MEDAL_DEFENDER_MEDAL_NAME
     description: STR_MEDAL_DEFENDER_MEDAL_DESCRIPTION
+    sprite: 103
     criteria:
       total_base_defense_missions: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
   - type: STR_MEDAL_LONGEST_NIGHT_NAME
     description: STR_MEDAL_LONGEST_NIGHT_DESCRIPTION
+    sprite: 104
     criteria:
       total_night_terror_missions: [1, 2, 3, 4, 5, 7, 9, 11, 15, 20]
   - type: STR_MEDAL_HONOR_CROSS_NAME
     description: STR_MEDAL_HONOR_CROSS_DESCRIPTION
+    sprite: 105
     criteria:
       total_monthly_service: [1]
   - type: STR_MEDAL_SERVICE_MEDAL_NAME
     description: STR_MEDAL_SERVICE_MEDAL_DESCRIPTION
+    sprite: 106
     criteria:
       total_monthly_service: [3, 6, 9, 12, 15, 18, 21, 24, 27, 30]
   - type: STR_MEDAL_WEAPON_PROFICIENCY_NAME
     description: STR_MEDAL_WEAPON_PROFICIENCY_DESCRIPTION
+    sprite: 107
     criteria:
       total_kills_with_a_weapon: [3, 6, 9, 12, 15, 18, 21, 24, 27, 30]
   - type: STR_MEDAL_CAMPAIGN_RIBBON_NAME
     description: STR_MEDAL_CAMPAIGN_RIBBON_DESCRIPTION
+    sprite: 108
     criteria:
       total_missions_in_a_region: [3, 6, 9, 12, 15, 18, 21, 24, 27, 30]
   - type: STR_MEDAL_XENOCIDE_MEDAL_NAME
     description: STR_MEDAL_XENOCIDE_MEDAL_DESCIRPTION
+    sprite: 109
     criteria:
       total_kills_by_race: [3, 6, 9, 12, 15, 18, 21, 24, 27, 30]

src/Basescape/SoldierDiaryKillsState.cpp

@@ -25,6 +25,7 @@
 #include "../Engine/Language.h"
 #include "../Engine/Palette.h"
 #include "../Engine/Options.h"
+#include "../Engine/SurfaceSet.h"
 #include "../Geoscape/AllocatePsiTrainingState.h"
 #include "../Interface/TextButton.h"
 #include "../Interface/Window.h"
@@ -36,6 +37,7 @@
 #include "../Savegame/SoldierDiary.h"
 #include "../Ruleset/RuleCraft.h"
 
+
 namespace OpenXcom
 {
 
@@ -94,7 +96,7 @@ SoldierDiaryKillsState::SoldierDiaryKillsState(Game *game, Base *base, size_t so
     _txtMedalName = new Text(90, 18, 16, 36);
     _txtMedalLevel = new Text(90, 18, 216, 36);
 	_txtMedalInfo = new Text(280, 32, 20, 150);
-    _lstCommendations = new TextList(272, 100, 16, 52);
+    _lstCommendations = new TextList(272, 100, 48, 52);
 
 	// Set palette
 	_game->setPalette(_game->getResourcePack()->getPalette("BACKPALS.DAT")->getColors(Palette::blockOffset(2)), Palette::backPos, 16);
@@ -247,12 +249,16 @@ SoldierDiaryKillsState::SoldierDiaryKillsState(Game *game, Base *base, size_t so
 
 	_lstCommendations->setColor(Palette::blockOffset(13)+10);
 	_lstCommendations->setArrowColor(Palette::blockOffset(15)+1);
-	_lstCommendations->setColumns(2, 200, 80);
+	_lstCommendations->setColumns(2, 168, 80);
 	_lstCommendations->setSelectable(true);
 	_lstCommendations->setBackground(_window);
 	_lstCommendations->onMouseOver((ActionHandler)&SoldierDiaryKillsState::lstInfoMouseOver);
 	_lstCommendations->onMouseOut((ActionHandler)&SoldierDiaryKillsState::lstInfoMouseOut);
 
+
+	
+	
+
 	init(); // Populate the list
 }
 
@@ -323,6 +329,7 @@ void SoldierDiaryKillsState::init()
 	std::map<std::string, int> _typeTotals = s->getDiary()->getTypeTotal();
 	std::map<std::string, int> _UFOTotals = s->getDiary()->getUFOTotal();
     _lstCommendations->clearList();
+	int row;
 
 	for (std::map<std::string, int>::const_iterator i = _raceTotals.begin() ; i != _raceTotals.end() ; ++i)
 	{
@@ -379,9 +386,12 @@ void SoldierDiaryKillsState::init()
 		_lstUFO->addRow(2, ss1.str().c_str(), ss2.str().c_str());
 	}
 
+	row = 0;
     for (std::vector<SoldierCommendations*>::const_iterator i = s->getDiary()->getSoldierCommendations()->begin() ; i != s->getDiary()->getSoldierCommendations()->end() ; ++i)
 	{
 		std::wstringstream ss1, ss2, ss3;
+		int _sprite = (*i)->getSprite();
+		Surface *_image = new Surface(30, 8, 16, 52 + 8*row);
 
 		if ((*i)->getNoun() != "")
 		{
@@ -397,6 +407,14 @@ void SoldierDiaryKillsState::init()
 		_lstCommendations->addRow(2, ss1.str().c_str(), ss2.str().c_str());
 
 		_commendationsListEntry.push_back(ss3.str().c_str());
+
+		// Handle commendation sprites
+		add(_image);
+		SurfaceSet *texture = _game->getResourcePack()->getSurfaceSet("BIGOBS.PCK");
+		texture->getFrame(_sprite)->setX(0);
+		texture->getFrame(_sprite)->setY(0);
+		texture->getFrame(_sprite)->blit(_image);
+		row++;
 	}
 }
 

src/Ruleset/RuleCommendations.cpp

@@ -25,7 +25,7 @@ namespace OpenXcom
 /**
  * Creates a blank set of extra sprite data.
  */
-RuleCommendations::RuleCommendations() : _description(""), _criteria()
+RuleCommendations::RuleCommendations() : _description(""), _criteria(), _sprite()
 {
 }
 
@@ -44,6 +44,7 @@ void RuleCommendations::load(const YAML::Node &node, int listOrder)
 {
 	_description = node["description"].as<std::string>(_description);
 	_criteria = node["criteria"].as< std::map< std::string, std::vector<int> > >(_criteria);
+    _sprite = node["sprite"].as<int>(_sprite);
 	_listOrder = node["listOrder"].as<int>(_listOrder);
 	if (!_listOrder)
 	{
@@ -78,4 +79,13 @@ std::map<std::string, std::vector<int> > *RuleCommendations::getCriteria()
 	return &_criteria;
 }
 
+/**
+ * Get the commendation's sprite
+ * @return int Sprite number
+ */
+int RuleCommendations::getSprite() const
+{
+	return _sprite;
+}
+
 }

src/Ruleset/RuleCommendations.h

@@ -33,6 +33,7 @@ class RuleCommendations
 	std::map<std::string, std::vector<int> > _criteria;
 	std::string _description;
 	int _listOrder;
+	int _sprite;
 public:
 	/// Creates a blank commendation ruleset.
 	RuleCommendations();
@@ -48,6 +49,8 @@ class RuleCommendations
 	std::string getDescription() const;
 	/// Get commendation award criteria
 	std::map<std::string, std::vector<int> > *getCriteria();
+	/// Get sprite
+	int getSprite() const;
 
 };
 

src/Savegame/SoldierDiary.cpp

@@ -371,7 +371,8 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
                 // match nouns and decoration levels
                 for(std::map<std::string, int>::const_iterator k = _weaponTotal.begin(); k != _weaponTotal.end(); ++k)
                 {
-					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), (*j).second.at(_nextCommendationLevel.at((*k).first)));
+					int _criteria = _nextCommendationLevel[""] == 0 ? 0 : (*j).second.at(_nextCommendationLevel.at((*k).first));
+					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), _criteria);
                 }
 				// If it is still empty, we did not get a commendation
 				if (_modularCommendations.empty())
@@ -384,7 +385,8 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 			{
 				for(std::map<std::string, int>::const_iterator k = _regionTotal.begin(); k != _regionTotal.end(); ++k)
 				{
-					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), (*j).second.at(_nextCommendationLevel.at((*k).first)));
+					int _criteria = _nextCommendationLevel[""] == 0 ? 0 : (*j).second.at(_nextCommendationLevel.at((*k).first));
+					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), _criteria);
 				}
 				if (_modularCommendations.empty())
 				{
@@ -396,7 +398,8 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 			{
 				for(std::map<std::string, int>::const_iterator k = _alienRaceTotal.begin(); k != _alienRaceTotal.end(); ++k)
 				{
-					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), (*j).second.at(_nextCommendationLevel.at((*k).first)));
+					int _criteria = _nextCommendationLevel[""] == 0 ? 0 : (*j).second.at(_nextCommendationLevel.at((*k).first));
+					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), _criteria);
 				}
 				if (_modularCommendations.empty())
 				{
@@ -408,7 +411,8 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 			{
 				for(std::map<std::string, int>::const_iterator k = _alienRankTotal.begin(); k != _alienRankTotal.end(); ++k)
 				{
-					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), (*j).second.at(_nextCommendationLevel.at((*k).first)));
+					int _criteria = _nextCommendationLevel[""] == 0 ? 0 : (*j).second.at(_nextCommendationLevel.at((*k).first));
+					manageModularCommendations(_nextCommendationLevel, _modularCommendations, (*k), _criteria);
 				}
 				if (_modularCommendations.empty())
 				{
@@ -427,7 +431,7 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
             }
             for (std::map<std::string, int>::const_iterator j = _modularCommendations.begin(); j != _modularCommendations.end(); ++j)
             {
-                awardCommendation((*i).first, (*i).second->getDescription(), (*j).first);
+                awardCommendation((*i).first, (*i).second->getDescription(), (*j).first, (*i).second->getSprite());
 				_awardedCommendation = true;
             }
 		}
@@ -439,26 +443,25 @@ bool SoldierDiary::manageCommendations(Ruleset *rules)
 /**
  * Manage modular commendations (private)
  */
-void SoldierDiary::manageModularCommendations(std::map<std::string, int> progress, std::map<std::string, int> modularCommendations, std::pair<std::string, int> weaponTotal, int currentLevel)
+void SoldierDiary::manageModularCommendations(std::map<std::string, int> nextCommendationLevel, std::map<std::string, int> modularCommendations, std::pair<std::string, int> statTotal, int criteria)
 {
-	int _criteria = progress[""] == 0 ? 0 : currentLevel;
 	// If criteria is 0, we don't have this noun
-	if (_criteria == 0 && weaponTotal.second >= _criteria)
+	if (criteria == 0 && statTotal.second >= criteria)
 	{
-		modularCommendations[weaponTotal.first]++;
+		modularCommendations[statTotal.first]++;
 	}
 	// If we meet the criteria, remember the noun for award purposes
-    else if (_criteria != 0 && progress.at(weaponTotal.first) >= _criteria)
+    else if (criteria != 0 && nextCommendationLevel.at(statTotal.first) >= criteria)
     {
-        modularCommendations[weaponTotal.first]++;
+        modularCommendations[statTotal.first]++;
     }
 }
 
 /**
  * Award commendations to the soldier.
  * @param string Commendation Name.
  */
-void SoldierDiary::awardCommendation(std::string _commendationName, std::string _commendationDescription, std::string _noun)
+void SoldierDiary::awardCommendation(std::string _commendationName, std::string _commendationDescription, std::string _noun, int sprite)
 {
 	bool _newCommendation = true;
 
@@ -473,7 +476,7 @@ void SoldierDiary::awardCommendation(std::string _commendationName, std::string
 	}
 	if (_newCommendation)
 	{
-		_commendations.push_back(new SoldierCommendations(_commendationName, _commendationDescription, _noun, 0, true));
+		_commendations.push_back(new SoldierCommendations(_commendationName, _commendationDescription, _noun, 0, true, sprite));
 	}
 }
 
@@ -812,7 +815,7 @@ SoldierCommendations::SoldierCommendations(const YAML::Node &node)
 /**
  * Initializes a soldier commendation.
  */
-SoldierCommendations::SoldierCommendations(std::string commendationName, std::string commendationDescription, std::string noun, int decorationLevel, bool isNew) : _commendationName(commendationName), _commendationDescription(commendationDescription), _noun(noun), _decorationLevel(decorationLevel), _isNew(isNew)
+SoldierCommendations::SoldierCommendations(std::string commendationName, std::string commendationDescription, std::string noun, int decorationLevel, bool isNew, int sprite) : _commendationName(commendationName), _commendationDescription(commendationDescription), _noun(noun), _decorationLevel(decorationLevel), _isNew(isNew), _sprite(sprite)
 {
 
 }
@@ -835,6 +838,7 @@ void SoldierCommendations::load(const YAML::Node &node)
 	_noun = node["noun"].as<std::string>(_noun);
 	_decorationLevel = node["decorationLevel"].as<int>(_decorationLevel);
 	_isNew = node["isNew"].as<bool>(_isNew);
+	_sprite = node["sprite"].as<int>(_sprite);
 }
 
 /**
@@ -849,6 +853,7 @@ YAML::Node SoldierCommendations::save() const
 	node["noun"] = _noun;
 	node["decorationLevel"] = _decorationLevel;
 	node["isNew"] = _isNew;
+	node["sprite"] = _sprite;
 	return node;
 }
 
@@ -960,4 +965,13 @@ void SoldierCommendations::addDecoration()
 	_isNew = true;
 }
 
+/**
+ * Get the sprite int
+ * @return sprite int
+ */
+int SoldierCommendations::getSprite() const
+{
+	return _sprite;
+}
+
 }

src/Savegame/SoldierDiary.h

@@ -136,13 +136,13 @@ class SoldierCommendations
 private:
 	RuleCommendations *_rules;
 	std::string  _commendationName, _commendationDescription, _noun;
-	int  _decorationLevel;
+	int  _decorationLevel, _sprite;
 	bool _isNew;
 public:
 	/// Creates a new commendation and loads its contents from YAML.
 	SoldierCommendations(const YAML::Node& node);
 	/// Creates a commendation of the specified type.
-	SoldierCommendations(std::string commendationName, std::string commendationDescription, std::string noun, int decorationLevel, bool isNew);
+	SoldierCommendations(std::string commendationName, std::string commendationDescription, std::string noun, int decorationLevel, bool isNew, int sprite);
 	/// Cleans up the commendation.
 	~SoldierCommendations();
 	/// Loads the commendation information from YAML.
@@ -168,6 +168,8 @@ class SoldierCommendations
 	/// Increment decoration level.
 	// Sets _isNew to true.
 	void addDecoration();
+	/// Get sprite
+	int getSprite() const;
 };
 
 class SoldierDiary
@@ -180,7 +182,7 @@ class SoldierDiary
 	int _scoreTotal, _killTotal, _missionTotal, _winTotal, _stunTotal, _daysWoundedTotal, _baseDefenseMissionTotal,
 		_terrorMissionTotal, _nightMissionTotal, _nightTerrorMissionTotal, _monthsService;
 
-	void manageModularCommendations(std::map<std::string, int> progress, std::map<std::string, int> modularCommendations, std::pair<std::string, int> weaponTotal, int currentLevel);
+	void manageModularCommendations(std::map<std::string, int> nextCommendationLevel, std::map<std::string, int> modularCommendations, std::pair<std::string, int> statTotal, int criteria);
 public:
 	/// Creates a new soldier-equipment layout item and loads its contents from YAML.
 	SoldierDiary(const YAML::Node& node);
@@ -239,7 +241,7 @@ class SoldierDiary
 	/// Manage commendations, return true if a medal is awarded.
 	bool manageCommendations(Ruleset *rules);
 	/// Award commendations
-	void awardCommendation(std::string commendationName, std::string commendationDescription, std::string noun = "");
+	void awardCommendation(std::string commendationName, std::string commendationDescription, std::string noun = "", int sprite = 100);
 	/// Increment soldier's service time.
 	void addMonthlyService();
 };