Adjust map tile path trail indicators for taking a map screenshot

Author: JasonNumberThirteen

Assets/Project/Scenes/VisualiserScene.unity

@@ -1,12 +1,30 @@
 using DG.Tweening;
 using UnityEngine;
 
-public class MapTilePathTrailIndicator : MonoBehaviour
+public class MapTilePathTrailIndicator : MonoBehaviour, IMapScreenshotTakerElement
 {
 	[SerializeField, Min(0f)] private float movementPeriodOfOscillation = 3f;
 	[SerializeField, Range(0f, 0.5f)] private float movementDistanceFromCenterOfTile = 0.125f;
 
 	private Tween movementTween;
+	private Vector2 lastLocalPosition;
+
+	public void AdjustForTakingMapScreenshot(bool started)
+	{
+		if(started)
+		{
+			movementTween?.Pause();
+
+			lastLocalPosition = transform.localPosition;
+			transform.localPosition = Vector2.zero;
+		}
+		else
+		{
+			transform.localPosition = lastLocalPosition;
+
+			movementTween?.Play();
+		}
+	}
 
 	public void Setup(MapTileNode currentMapTileNode, MapTileNode nextMapTileNode)
 	{

Assets/Project/Scripts/Game Objects/Indicators/MapTilePathTrailIndicator.cs

@@ -0,0 +1,73 @@
+using System.Linq;
+using System.Collections.Generic;
+using UnityEngine;
+
+public class MapScreenshotTakerElementsManager : MonoBehaviour
+{
+	private MapScreenshotTaker mapScreenshotTaker;
+	private MapTilesPathTrailManager mapTilesPathTrailManager;
+
+	private readonly List<IMapScreenshotTakerElement> mapScreenshotTakerElements = new();
+
+	private void Awake()
+	{
+		mapScreenshotTaker = ObjectMethods.FindComponentOfType<MapScreenshotTaker>();
+		mapTilesPathTrailManager = ObjectMethods.FindComponentOfType<MapTilesPathTrailManager>();
+
+		RegisterToListeners(true);
+	}
+
+	private void OnDestroy()
+	{
+		RegisterToListeners(false);
+	}
+
+	private void RegisterToListeners(bool register)
+	{
+		if(register)
+		{
+			if(mapScreenshotTaker != null)
+			{
+				mapScreenshotTaker.takingScreenshotStateWasChangedEvent.AddListener(AdjustAllElementsForTakingMapScreenshot);
+			}
+			
+			if(mapTilesPathTrailManager != null)
+			{
+				mapTilesPathTrailManager.indicatorsWereAddedEvent.AddListener(OnIndicatorsWereAdded);
+				mapTilesPathTrailManager.indicatorsWereRemovedEvent.AddListener(OnIndicatorsWereRemoved);
+			}
+		}
+		else
+		{
+			if(mapScreenshotTaker != null)
+			{
+				mapScreenshotTaker.takingScreenshotStateWasChangedEvent.RemoveListener(AdjustAllElementsForTakingMapScreenshot);
+			}
+			
+			if(mapTilesPathTrailManager != null)
+			{
+				mapTilesPathTrailManager.indicatorsWereAddedEvent.RemoveListener(OnIndicatorsWereAdded);
+				mapTilesPathTrailManager.indicatorsWereRemovedEvent.RemoveListener(OnIndicatorsWereRemoved);
+			}
+		}
+	}
+
+	private void AdjustAllElementsForTakingMapScreenshot(bool started)
+	{
+		mapScreenshotTakerElements.ForEach(mapScreenshotTakerElement => mapScreenshotTakerElement.AdjustForTakingMapScreenshot(started));
+	}
+
+	private void OnIndicatorsWereAdded(List<MapTilePathTrailIndicator> mapTilePathTrailIndicators)
+	{
+		mapScreenshotTakerElements.AddRange(GetElementsFrom(mapTilePathTrailIndicators));
+	}
+
+	private void OnIndicatorsWereRemoved(List<MapTilePathTrailIndicator> mapTilePathTrailIndicators)
+	{
+		var elementsFromMapTilePathTrailIndicators = GetElementsFrom(mapTilePathTrailIndicators);
+
+		mapScreenshotTakerElements.RemoveAll(elementsFromMapTilePathTrailIndicators.Contains);
+	}
+
+	private IEnumerable<IMapScreenshotTakerElement> GetElementsFrom<T>(List<T> components) => components.OfType<IMapScreenshotTakerElement>();
+}

Assets/Project/Scripts/Game Objects/Managers/MapScreenshotTakerElementsManager.cs

@@ -1,20 +1,25 @@
 using System.Collections.Generic;
 using UnityEngine;
+using UnityEngine.Events;
 
 public class MapTilesPathTrailManager : MonoBehaviour
 {
+	public UnityEvent<List<MapTilePathTrailIndicator>> indicatorsWereAddedEvent;
+	public UnityEvent<List<MapTilePathTrailIndicator>> indicatorsWereRemovedEvent;
+	
 	[SerializeField] private MapTilePathTrailIndicator mapTilePathTrailIndicatorPrefab;
 
 	private bool pathTrailIsEnabled;
 	private MapPathManager mapPathManager;
 
-	private readonly List<MapTilePathTrailIndicator> mapTilePathTrailIndicators = new();
+	private readonly List<MapTilePathTrailIndicator> allMapTilePathTrailIndicators = new();
+	private readonly List<MapTilePathTrailIndicator> modifiedMapTilePathTrailIndicators = new();
 
 	public void SetPathTrailEnabled(bool enabled)
 	{
 		pathTrailIsEnabled = enabled;
 
-		mapTilePathTrailIndicators.ForEach(mapTilePathTrailIndicator => mapTilePathTrailIndicator.SetActive(pathTrailIsEnabled));
+		allMapTilePathTrailIndicators.ForEach(mapTilePathTrailIndicator => mapTilePathTrailIndicator.SetActive(pathTrailIsEnabled));
 	}
 
 	private void Awake()
@@ -51,12 +56,16 @@ private void RegisterToListeners(bool register)
 
 	private void OnPathWasFound(List<MapTileNode> mapTileNodes)
 	{
+		modifiedMapTilePathTrailIndicators.Clear();
 		mapTileNodes.ForEachReversed(CreateMapTilePathTrailIndicator);
+		indicatorsWereAddedEvent?.Invoke(modifiedMapTilePathTrailIndicators);
 	}
 
 	private void OnResultsWereCleared()
 	{
-		mapTilePathTrailIndicators.ForEachReversed(RemoveMapTilePathTrailIndicator);
+		modifiedMapTilePathTrailIndicators.Clear();
+		allMapTilePathTrailIndicators.ForEachReversed(RemoveMapTilePathTrailIndicator);
+		indicatorsWereRemovedEvent?.Invoke(modifiedMapTilePathTrailIndicators);
 	}
 
 	private void CreateMapTilePathTrailIndicator(MapTileNode currentMapTileNode, MapTileNode nextMapTileNode)
@@ -70,12 +79,24 @@ private void CreateMapTilePathTrailIndicator(MapTileNode currentMapTileNode, Map
 
 		mapTilePathTrailIndicator.Setup(currentMapTileNode, nextMapTileNode);
 		mapTilePathTrailIndicator.SetActive(pathTrailIsEnabled);
-		mapTilePathTrailIndicators.Add(mapTilePathTrailIndicator);
+		AddIndicator(mapTilePathTrailIndicator);
 	}
 
 	private void RemoveMapTilePathTrailIndicator(MapTilePathTrailIndicator mapTilePathTrailIndicator)
 	{
-		mapTilePathTrailIndicators.Remove(mapTilePathTrailIndicator);
+		RemoveIndicator(mapTilePathTrailIndicator);
 		Destroy(mapTilePathTrailIndicator.gameObject);
 	}
+
+	private void AddIndicator(MapTilePathTrailIndicator mapTilePathTrailIndicator)
+	{
+		allMapTilePathTrailIndicators.Add(mapTilePathTrailIndicator);
+		modifiedMapTilePathTrailIndicators.Add(mapTilePathTrailIndicator);
+	}
+
+	private void RemoveIndicator(MapTilePathTrailIndicator mapTilePathTrailIndicator)
+	{
+		allMapTilePathTrailIndicators.Remove(mapTilePathTrailIndicator);
+		modifiedMapTilePathTrailIndicators.Add(mapTilePathTrailIndicator);
+	}
 }

Assets/Project/Scripts/Game Objects/Managers/MapScreenshotTakerElementsManager.cs.meta

@@ -5,6 +5,7 @@
 
 public class MapScreenshotTaker : MonoBehaviour
 {
+	public UnityEvent<bool> takingScreenshotStateWasChangedEvent;
 	public UnityEvent<string> screenshotWasTakenEvent;
 
 	private MapScreenshotSceneCamera mapScreenshotSceneCamera;
@@ -16,14 +17,16 @@ public class MapScreenshotTaker : MonoBehaviour
 #endif
 	private static readonly int RENDER_TEXTURE_DEPTH = 24;
 	private static readonly TextureFormat RENDER_TEXTURE_FORMAT = TextureFormat.RGB24;
-	
+
 	public void TakeMapScreenshot()
 	{
 		var directoryPathFolder = GetDirectoryPathFolder();
 		var directoryPath = $"{directoryPathFolder}/{GetDirectoryName()}";
 
+		takingScreenshotStateWasChangedEvent?.Invoke(true);
 		EnsureExistanceOfDirectory(directoryPath);
 		TakeScreenshotInDirectory(directoryPath, directoryPathFolder);
+		takingScreenshotStateWasChangedEvent?.Invoke(false);
 	}
 
 	private void Awake()

Assets/Project/Scripts/Game Objects/Managers/Pathfinding/MapTilesPathTrailManager.cs

@@ -0,0 +1,4 @@
+public interface IMapScreenshotTakerElement
+{
+	void AdjustForTakingMapScreenshot(bool started);
+}