renames and comments a caching variable for clarity

Author: tomkail

Packages/Ink/Editor/Tools/Player Window/InkPlayerWindow.cs

@@ -569,7 +569,8 @@ public class VariablesPanelState : BaseStoryPanelState {
 			public List<string> expandedVariables = new List<string>();
 		}
 		public class ObservedVariablesPanelState : BaseStoryPanelState {
-			public List<string> observedVariableNames = new List<string>();
+			// The cache is used to restore observed variables when the user exits play mode.
+			public List<string> restorableObservedVariableNames = new List<string>();
 			public Dictionary<string, ObservedVariable> observedVariables = new Dictionary<string, ObservedVariable>();
 		}
 
@@ -871,7 +872,7 @@ static void OnUnsetStory () {
 			_story.onCompleteEvaluateFunction -= OnCompleteEvaluateFunction;
 			_story.onChoosePathString -= OnChoosePathString;
 			_story.state.onDidLoadState -= OnLoadState;
-			foreach(var observedVariableName in InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames) {
+			foreach(var observedVariableName in InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames) {
 				UnobserveVariable(observedVariableName, false);
 			}
 			InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Clear();
@@ -902,9 +903,9 @@ static void OnSetStory () {
 			}
 
 			// Reobserve variables
-			var variablesToObserve = new List<string>(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames);
+			var variablesToObserve = new List<string>(InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames);
 			InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Clear();
-			InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Clear();
+			InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Clear();
 			foreach(var observedVariableName in variablesToObserve) {
 				if(_story.variablesState.Contains(observedVariableName)) {
 					var observedVariable = ObserveVariable(observedVariableName, true);
@@ -2326,27 +2327,28 @@ static ObservedVariable ObserveVariable (string variableName, bool alsoAddToCach
 			story.ObserveVariable(variableName, observedVariable.variableObserver);
 			InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Add(variableName, observedVariable);
 			if(alsoAddToCache) {
-				InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Add(variableName);
-				if(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count != InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Count) {
-					Debug.LogError(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count +" "+ InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Count);
-					InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Clear();
+				InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Add(variableName);
+				if(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count != InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Count) {
+					Debug.LogError(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count +" "+ InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Count);
+					InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Clear();
 					InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Clear();
 				}
 			}
 			return observedVariable;
 		}
-
+		
+		// The cache is used to restore observed variables when the user exits play mode.
 		static void UnobserveVariable (string variableName, bool alsoRemoveFromCache) {
 			if(!InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.ContainsKey(variableName)) return;
 
 			var observedVariable = InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables[variableName];
 			story.RemoveVariableObserver(observedVariable.variableObserver, variableName);
 			InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Remove(variableName);
 			if(alsoRemoveFromCache) {
-				InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Remove(variableName);
-				if(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count != InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Count) {
-					Debug.LogError(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count +" "+ InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Count);
-					InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariableNames.Clear();
+				InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Remove(variableName);
+				if(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count != InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Count) {
+					Debug.LogError(InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Count +" "+ InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Count);
+					InkPlayerWindowState.Instance.observedVariablesPanelState.restorableObservedVariableNames.Clear();
 					InkPlayerWindowState.Instance.observedVariablesPanelState.observedVariables.Clear();
 				}
 			}