feat(enhancement): Allow missions to mark systems of importance (endl…

…ess-sky#9827)

source/GameAction.cpp

@@ -212,6 +212,10 @@ void GameAction::LoadSingle(const DataNode &child)
 		music = child.Token(1);
 	else if(key == "mute")
 		music = "";
+	else if(key == "mark" && hasValue)
+		mark.insert(GameData::Systems().Get(child.Token(1)));
+	else if(key == "unmark" && hasValue)
+		unmark.insert(GameData::Systems().Get(child.Token(1)));
 	else if(key == "fail" && hasValue)
 		fail.insert(child.Token(1));
 	else if(key == "fail")
@@ -268,6 +272,10 @@ void GameAction::Save(DataWriter &out) const
 	}
 	for(auto &&it : events)
 		out.Write("event", it.first->Name(), it.second.first, it.second.second);
+	for(const System *system : mark)
+		out.Write("mark", system->Name());
+	for(const System *system : unmark)
+		out.Write("unmark", system->Name());
 	for(const string &name : fail)
 		out.Write("fail", name);
 	if(failCaller)
@@ -305,6 +313,14 @@ string GameAction::Validate() const
 		if(!outfit.first->IsDefined())
 			return "gift outfit \"" + outfit.first->TrueName() + "\"";
 
+	// Marked and unmarked system must be valid.
+	for(auto &&system : mark)
+		if(!system->IsValid())
+			return "system \"" + system->Name() + "\"";
+	for(auto &&system : unmark)
+		if(!system->IsValid())
+			return "system \"" + system->Name() + "\"";
+
 	// It is OK for this action to try to fail a mission that does not exist.
 	// (E.g. a plugin may be designed for interoperability with other plugins.)
 
@@ -395,6 +411,11 @@ void GameAction::Do(PlayerInfo &player, UI *ui, const Mission *caller) const
 	for(const auto &it : events)
 		player.AddEvent(*it.first, player.GetDate() + it.second.first);
 
+	for(const System *system : mark)
+		caller->Mark(system);
+	for(const System *system : unmark)
+		caller->Unmark(system);
+
 	if(!fail.empty())
 	{
 		// If this action causes this or any other mission to fail, mark that
@@ -465,5 +486,8 @@ GameAction GameAction::Instantiate(map<string, string> &subs, int jumps, int pay
 
 	result.conditions = conditions;
 
+	result.mark = mark;
+	result.unmark = unmark;
+
 	return result;
 }

source/GameAction.h

@@ -34,6 +34,7 @@ class Mission;
 class Outfit;
 class PlayerInfo;
 class Ship;
+class System;
 class UI;
 
 
@@ -101,6 +102,9 @@ class GameAction {
 
 	std::optional<std::string> music;
 
+	std::set<const System *> mark;
+	std::set<const System *> unmark;
+
 	// When this action is performed, the missions with these names fail.
 	std::set<std::string> fail;
 	// When this action is performed, the mission that called this action is failed.

source/MapPanel.cpp

@@ -511,6 +511,14 @@ void MapPanel::DrawMiniMap(const PlayerInfo &player, float alpha, const System *
 				if(stopover->IsInSystem(&system))
 					DrawPointer(from, missionCounter, waypointColor, false);
 			}
+
+			for(const System *mark : mission.MarkedSystems())
+			{
+				if(missionCounter >= MAX_MISSION_POINTERS_DRAWN)
+					break;
+				if(mark == &system)
+					DrawPointer(from, missionCounter, waypointColor, false);
+			}
 		}
 	}
 
@@ -1473,6 +1481,8 @@ void MapPanel::DrawMissions()
 			DrawPointer(waypoint, missionCount[waypoint].drawn, waypointColor);
 		for(const Planet *stopover : mission.Stopovers())
 			DrawPointer(stopover->GetSystem(), missionCount[stopover->GetSystem()].drawn, waypointColor);
+		for(const System *mark : mission.MarkedSystems())
+			DrawPointer(mark, missionCount[mark].drawn, waypointColor);
 	}
 	// Draw the available and unavailable jobs.
 	for(auto &&it : missionCount)

source/Mission.cpp

@@ -284,6 +284,12 @@ void Mission::Load(const DataNode &node)
 		}
 		else if(child.Token(0) == "stopover" && child.HasChildren())
 			stopoverFilters.emplace_back(child);
+		else if(child.Token(0) == "mark" && child.Size() >= 2)
+		{
+			bool unmarked = child.Size() >= 3 && child.Token(2) == "unmarked";
+			set<const System *> &set = unmarked ? unmarkedSystems : markedSystems;
+			set.insert(GameData::Systems().Get(child.Token(1)));
+		}
 		else if(child.Token(0) == "substitutions" && child.HasChildren())
 			substitutions.Load(child);
 		else if(child.Token(0) == "npc")
@@ -451,6 +457,11 @@ void Mission::Save(DataWriter &out, const string &tag) const
 		for(const Planet *planet : visitedStopovers)
 			out.Write("stopover", planet->TrueName(), "visited");
 
+		for(const System *system : markedSystems)
+			out.Write("mark", system->Name());
+		for(const System *system : unmarkedSystems)
+			out.Write("mark", system->Name(), "unmarked");
+
 		for(const NPC &npc : npcs)
 			npc.Save(out);
 
@@ -535,6 +546,12 @@ bool Mission::IsValid() const
 	for(auto &&system : VisitedWaypoints())
 		if(!system->IsValid())
 			return false;
+	for(auto &&system : MarkedSystems())
+		if(!system->IsValid())
+			return false;
+	for(auto &&system : UnmarkedSystems())
+		if(!system->IsValid())
+			return false;
 
 	// Actions triggered when entering a system should reference valid systems.
 	for(auto &&it : onEnter)
@@ -629,6 +646,36 @@ const set<const Planet *> &Mission::VisitedStopovers() const
 
 
 
+const set<const System *> &Mission::MarkedSystems() const
+{
+	return markedSystems;
+}
+
+
+
+const set<const System *> &Mission::UnmarkedSystems() const
+{
+	return unmarkedSystems;
+}
+
+
+
+void Mission::Mark(const System *system) const
+{
+	markedSystems.insert(system);
+	unmarkedSystems.erase(system);
+}
+
+
+
+void Mission::Unmark(const System *system) const
+{
+	if(markedSystems.erase(system))
+		unmarkedSystems.insert(system);
+}
+
+
+
 const string &Mission::Cargo() const
 {
 	return cargo;
@@ -1239,6 +1286,7 @@ Mission Mission::Instantiate(const PlayerInfo &player, const shared_ptr<Ship> &b
 	result.repeat = repeat;
 	result.name = name;
 	result.waypoints = waypoints;
+	result.markedSystems = markedSystems;
 	// Handle waypoint systems that are chosen randomly.
 	const System *const sourceSystem = player.GetSystem();
 	for(const LocationFilter &filter : waypointFilters)
@@ -1405,20 +1453,23 @@ Mission Mission::Instantiate(const PlayerInfo &player, const shared_ptr<Ship> &b
 		subs["<stopovers>"] = stopovers;
 		subs["<planet stopovers>"] = planets;
 	}
-	// Waypoints: "<system name>" with "," and "and".
-	if(!result.waypoints.empty())
-	{
+	// Waypoints and marks: "<system name>" with "," and "and".
+	auto systemsReplacement = [](const set<const System *> &systemsSet) -> string {
 		string systems;
-		const System * const *last = &*--result.waypoints.end();
+		const System * const *last = &*--systemsSet.end();
 		int count = 0;
-		for(const System * const &system : result.waypoints)
+		for(const System * const &system : systemsSet)
 		{
 			if(count++)
 				systems += (&system != last) ? ", " : (count > 2 ? ", and " : " and ");
 			systems += system->Name();
 		}
-		subs["<waypoints>"] = systems;
-	}
+		return systems;
+	};
+	if(!result.waypoints.empty())
+		subs["<waypoints>"] = systemsReplacement(result.waypoints);
+	if(!result.markedSystems.empty())
+		subs["<marks>"] = systemsReplacement(result.markedSystems);
 
 	// Instantiate the NPCs. This also fills in the "<npc>" substitution.
 	string reason;

source/Mission.h

@@ -97,6 +97,10 @@ class Mission {
 	const std::set<const System *> &VisitedWaypoints() const;
 	const std::set<const Planet *> &Stopovers() const;
 	const std::set<const Planet *> &VisitedStopovers() const;
+	const std::set<const System *> &MarkedSystems() const;
+	const std::set<const System *> &UnmarkedSystems() const;
+	void Mark(const System *system) const;
+	void Unmark(const System *system) const;
 	const std::string &Cargo() const;
 	int CargoSize() const;
 	int IllegalCargoFine() const;
@@ -247,6 +251,10 @@ class Mission {
 	std::list<LocationFilter> stopoverFilters;
 	std::set<const Planet *> visitedStopovers;
 	std::set<const System *> visitedWaypoints;
+	// Systems that don't need to be visited, but which the mission still
+	// wants to highlight for the player.
+	mutable std::set<const System *> markedSystems;
+	mutable std::set<const System *> unmarkedSystems;
 
 	// User-defined text replacements unique to this mission:
 	TextReplacements substitutions;

source/MissionPanel.cpp

@@ -74,6 +74,10 @@ namespace {
 			if(stopover->IsInSystem(system))
 				return true;
 
+		for(const System *mark : mission.MarkedSystems())
+			if(mark == system)
+				return true;
+
 		return false;
 	}
 
@@ -656,7 +660,7 @@ void MissionPanel::DrawKey() const
 		"Too little space to accept",
 		"Active job; go here to complete",
 		"Has unfinished requirements",
-		"Waypoint you must visit"
+		"System of importance"
 	};
 	int selected = -1;
 	if(availableIt != available.end())
@@ -679,9 +683,11 @@ void MissionPanel::DrawKey() const
 void MissionPanel::DrawMissionSystem(const Mission &mission, const Color &color) const
 {
 	auto toVisit = set<const System *>{mission.Waypoints()};
+	toVisit.insert(mission.MarkedSystems().begin(), mission.MarkedSystems().end());
 	for(const Planet *planet : mission.Stopovers())
 		toVisit.insert(planet->GetSystem());
 	auto hasVisited = set<const System *>{mission.VisitedWaypoints()};
+	hasVisited.insert(mission.UnmarkedSystems().begin(), mission.UnmarkedSystems().end());
 	for(const Planet *planet : mission.VisitedStopovers())
 		hasVisited.insert(planet->GetSystem());
 
@@ -1112,6 +1118,12 @@ void MissionPanel::CycleInvolvedSystems(const Mission &mission)
 			return;
 		}
 
+	for(const System *mark : mission.MarkedSystems())
+		if(++index == cycleInvolvedIndex)
+		{
+			CenterOnSystem(mark);
+			return;
+		}
 
 	cycleInvolvedIndex = 0;
 	CenterOnSystem(mission.Destination()->GetSystem());

source/PlayerInfo.cpp

@@ -2405,6 +2405,8 @@ bool PlayerInfo::HasSeen(const System &system) const
 			return false;
 		if(m.Waypoints().count(&system))
 			return true;
+		if(m.MarkedSystems().count(&system))
+			return true;
 		for(auto &&p : m.Stopovers())
 			if(p->IsInSystem(&system))
 				return true;