Merge pull request OpenXcom#1021 from myk002/mission_triggers

Mission triggers

Author: Warboy1982

bin/standard/xcom1/alienDeployments.rul

@@ -1223,8 +1223,8 @@ alienDeployments:
     shade: 15
     race: STR_SECTOID
     nextStage: STR_MARS_THE_FINAL_ASSAULT
-    noRetreat: true
     finalDestination: true
+    loseCutscene: losegame
     briefing:
       textOffset: -16
       palette: 6
@@ -1380,13 +1380,13 @@ alienDeployments:
       - UBASE
     shade: 5
     race: STR_MIXED
-    noRetreat: true
-    finalMission: true
+    winCutscene: wingame
+    loseCutscene: losegame
     briefing:
       textOffset: -16
       palette: 6
       music: GMNEWMAR
       showTarget: false
       showCraft: false
       background: BACK01.SCR
-    script: BOSSBATTLE
+    script: BOSSBATTLE

src/Battlescape/BattlescapeState.cpp

@@ -1936,35 +1936,25 @@ void BattlescapeState::finishBattle(bool abort, int inExitArea)
 		_animTimer->stop();
 		_gameTimer->stop();
 		_game->popState();
-		if (abort || (!abort  && inExitArea == 0))
+		_game->pushState(new DebriefingState);
+		std::string cutscene;
+		if (_game->getRuleset()->getDeployment(_save->getMissionType()))
 		{
-			// abort was done or no player is still alive
-			// this concludes to defeat when in mars or mars landing mission
-			if (_game->getRuleset()->getDeployment(_save->getMissionType()) &&
-				_game->getRuleset()->getDeployment(_save->getMissionType())->isNoRetreat() &&
-				_game->getSavedGame()->getMonthsPassed() > -1)
+			if (abort || inExitArea == 0)
 			{
-				_game->pushState(new CutsceneState("losegame"));
+				cutscene = _game->getRuleset()->getDeployment(_save->getMissionType())->getLoseCutscene();
 			}
 			else
 			{
-				_game->pushState(new DebriefingState);
+				cutscene = _game->getRuleset()->getDeployment(_save->getMissionType())->getWinCutscene();
 			}
 		}
-		else
+		if (!cutscene.empty())
 		{
-			// no abort was done and at least a player is still alive
-			// this concludes to victory when in mars mission
-			if (_game->getRuleset()->getDeployment(_save->getMissionType()) &&
-				_game->getRuleset()->getDeployment(_save->getMissionType())->isFinalMission() &&
-				_game->getSavedGame()->getMonthsPassed() > -1)
-			{
-				_game->pushState(new CutsceneState("wingame"));
-			}
-			else
-			{
-				_game->pushState(new DebriefingState);
-			}
+			// if cutscene is "wingame" or "losegame", then the DebriefingState
+			// pushed above will get popped without being shown.  otherwise
+			// it will get shown after the cutscene.
+			_game->pushState(new CutsceneState(cutscene));
 		}
 	}
 }

src/Ruleset/AlienDeployment.cpp

@@ -108,7 +108,7 @@ namespace OpenXcom
  * type of deployment data.
  * @param type String defining the type.
  */
-AlienDeployment::AlienDeployment(const std::string &type) : _type(type), _width(0), _length(0), _height(0), _civilians(0), _shade(-1), _noRetreat(false), _finalDestination(false), _finalMission(false), _markerIcon(-1), _durationMin(0), _durationMax(0), _minDepth(0), _maxDepth(0), _minSiteDepth(0), _maxSiteDepth(0)
+AlienDeployment::AlienDeployment(const std::string &type) : _type(type), _width(0), _length(0), _height(0), _civilians(0), _shade(-1), _finalDestination(false), _markerIcon(-1), _durationMin(0), _durationMax(0), _minDepth(0), _maxDepth(0), _minSiteDepth(0), _maxSiteDepth(0)
 {
 }
 
@@ -135,9 +135,9 @@ void AlienDeployment::load(const YAML::Node &node)
 	_shade = node["shade"].as<int>(_shade);
 	_nextStage = node["nextStage"].as<std::string>(_nextStage);
 	_race = node["race"].as<std::string>(_race);
-	_noRetreat = node["noRetreat"].as<bool>(_noRetreat);
 	_finalDestination = node["finalDestination"].as<bool>(_finalDestination);
-	_finalMission = node["finalMission"].as<bool>(_finalMission);
+	_winCutscene = node["winCutscene"].as<std::string>(_winCutscene);
+	_loseCutscene = node["loseCutscene"].as<std::string>(_loseCutscene);
 	_script = node["script"].as<std::string>(_script);
 	_alert = node["alert"].as<std::string>(_alert);
 	_briefingData = node["briefing"].as<BriefingData>(_briefingData);
@@ -251,30 +251,30 @@ std::string AlienDeployment::getScript() const
 }
 
 /**
- * Gets if aborting this mission will fail the game.
- * @return if aborting this mission will fail the game.
+ * Gets if winning this mission completes the game.
+ * @return if winning this mission completes the game.
  */
-bool AlienDeployment::isNoRetreat() const
+bool AlienDeployment::isFinalDestination() const
 {
-	return _noRetreat;
+	return _finalDestination;
 }
 
 /**
- * Gets if winning this mission completes the game.
- * @return if winning this mission completes the game.
+ * Gets the cutscene to play when the mission is won.
+ * @return the cutscene to play when the mission is won.
  */
-bool AlienDeployment::isFinalDestination() const
+std::string AlienDeployment::getWinCutscene() const
 {
-	return _finalDestination;
+	return _winCutscene;
 }
 
 /**
- * Gets if winning this mission completes the game.
- * @return if winning this mission completes the game.
+ * Gets the cutscene to play when the mission is lost.
+ * @return the cutscene to play when the mission is lost.
  */
-bool AlienDeployment::isFinalMission() const
+std::string AlienDeployment::getLoseCutscene() const
 {
-	return _finalMission;
+	return _loseCutscene;
 }
 
 /**

src/Ruleset/AlienDeployment.h

@@ -67,7 +67,8 @@ class AlienDeployment
 	std::vector<std::string> _terrains, _music;
 	int _shade;
 	std::string _nextStage, _race, _script;
-	bool _noRetreat, _finalDestination, _finalMission;
+	bool _finalDestination;
+	std::string _winCutscene, _loseCutscene;
 	std::string _alert;
 	BriefingData _briefingData;
 	std::string _markerName;
@@ -97,12 +98,12 @@ class AlienDeployment
 	std::string getRace() const;
 	/// Gets the script to use for this deployment.
 	std::string getScript() const;
-	/// Checks if aborting this mission will fail the game (all mars and t'leth stages).
-	bool isNoRetreat() const;
 	/// Checks if this is the destination for the final mission (mars stage 1, t'leth stage 1).
 	bool isFinalDestination() const;
-	/// Checks if winning this mission will complete the game (mars stage 2, t'leth stage 3).
-	bool isFinalMission() const;
+	/// Gets the cutscene to play when this mission is won.
+	std::string getWinCutscene() const;
+	/// Gets the cutscene to play when this mission is lost.
+	std::string getLoseCutscene() const;
 	/// Gets the alert message for this mission type.
 	std::string getAlertMessage() const;
 	/// Gets the briefing data for this mission type.