Changed "Hide non-overridden prefab variables" options to "Hide redundant prefab references" which now also apply to C# scripts' and prefab assets' usages (#42)

Author: yasirkula

Plugins/AssetUsageDetector/Editor/AssetUsageDetector.cs

@@ -53,8 +53,8 @@ public class Parameters
 #endif
 			public bool calculateUnusedObjects = false;
 			public bool hideDuplicateRows = true;
-			public bool hideNonOverriddenPrefabVariablesInAssets = true;
-			public bool hideNonOverriddenPrefabVariablesInScenes = false;
+			public bool hideRedundantPrefabReferencesInAssets = false;
+			public bool hideRedundantPrefabReferencesInScenes = false;
 			public bool noAssetDatabaseChanges = false;
 			public bool showDetailedProgressBar = true;
 		}
@@ -454,7 +454,7 @@ public SearchResult Run( Parameters searchParameters )
 					}
 
 					// If a reference is found in the Project view, save the results
-					if( currentSearchResultGroup.NumberOfReferences > 0 )
+					if( currentSearchResultGroup.AnyReferencesFound )
 						searchResult.Add( currentSearchResultGroup );
 				}
 
@@ -479,7 +479,7 @@ public SearchResult Run( Parameters searchParameters )
 						}
 					}
 
-					if( currentSearchResultGroup.NumberOfReferences > 0 )
+					if( currentSearchResultGroup.AnyReferencesFound )
 						searchResult.Add( currentSearchResultGroup );
 				}
 
@@ -554,7 +554,7 @@ public SearchResult Run( Parameters searchParameters )
 					for( int i = 0; i < rootGameObjects.Length; i++ )
 						SearchGameObjectRecursively( rootGameObjects[i] );
 
-					if( currentSearchResultGroup.NumberOfReferences > 0 )
+					if( currentSearchResultGroup.AnyReferencesFound )
 						searchResult.Add( currentSearchResultGroup );
 				}
 
@@ -663,7 +663,7 @@ private void InitializeSearchResultNodes( List<SearchResultGroup> searchResult )
 				searchResult[i].InitializeNodes( objectsToSearchSet );
 
 				// Remove empty search result groups
-				if( !searchResult[i].PendingSearch && searchResult[i].NumberOfReferences == 0 )
+				if( !searchResult[i].PendingSearch && !searchResult[i].AnyReferencesFound )
 					searchResult.RemoveAt( i-- );
 			}
 		}
@@ -982,11 +982,9 @@ private void SearchScene( string scenePath, List<SearchResultGroup> searchResult
 						EditorSceneManager.CloseScene( scene, true );
 				}
 			}
-			else
-			{
-				// Some references are found in this scene, save the results
+
+			if( currentSearchResultGroup.AnyReferencesFound )
 				searchResult.Add( currentSearchResultGroup );
-			}
 		}
 
 		// Search a GameObject and its children for references recursively

Plugins/AssetUsageDetector/Editor/AssetUsageDetectorSearchFunctions.cs

@@ -397,16 +397,21 @@ private ReferenceNode SearchGameObject( object obj )
 			// Check if this GameObject's prefab is one of the selected assets
 			if( searchPrefabConnections )
 			{
-#if UNITY_2018_3_OR_NEWER
-				Object prefab = go;
-				while( prefab = PrefabUtility.GetCorrespondingObjectFromSource( prefab ) )
-#else
-				Object prefab = PrefabUtility.GetPrefabParent( go );
-				if( prefab )
-#endif
+				bool? skipFurtherPrefabReferences = null;
+				for( GameObject goPrefab = go.GetPrefabParent(), prefab = goPrefab; prefab != null; prefab = prefab.GetPrefabParent() )
 				{
-					if( objectsToSearchSet.Contains( prefab ) && assetsToSearchRootPrefabs.ContainsFast( prefab as GameObject ) )
+					if( objectsToSearchSet.Contains( prefab ) && assetsToSearchRootPrefabs.ContainsFast( prefab ) )
 					{
+						if( goPrefab != prefab && !skipFurtherPrefabReferences.HasValue )
+						{
+							skipFurtherPrefabReferences = ShouldExcludeRedundantPrefabReferences( go ) && !go.HasAnyPrefabOverrides();
+							if( skipFurtherPrefabReferences.Value )
+							{
+								currentSearchResultGroup.NumberOfRedundantReferences++;
+								break;
+							}
+						}
+
 						referenceNode.AddLinkTo( GetReferenceNode( prefab ), "Prefab object" );
 
 						if( searchParameters.searchRefactoring != null )
@@ -440,10 +445,15 @@ private ReferenceNode SearchComponent( object obj )
 				MonoScript script = MonoScript.FromMonoBehaviour( (MonoBehaviour) component );
 				if( objectsToSearchSet.Contains( script ) )
 				{
-					referenceNode.AddLinkTo( GetReferenceNode( script ) );
+					if( ShouldExcludeRedundantPrefabReferences( component ) && !component.HasAnyPrefabOverrides() )
+						currentSearchResultGroup.NumberOfRedundantReferences++;
+					else
+					{
+						referenceNode.AddLinkTo( GetReferenceNode( script ) );
 
-					if( searchParameters.searchRefactoring != null )
-						searchParameters.searchRefactoring( new BehaviourUsageMatch( component.gameObject, script, component ) );
+						if( searchParameters.searchRefactoring != null )
+							searchParameters.searchRefactoring( new BehaviourUsageMatch( component.gameObject, script, component ) );
+					}
 				}
 			}
 
@@ -1452,9 +1462,7 @@ private void SearchVariablesWithSerializedObject( ReferenceNode referenceNode, b
 				if( iterator.Next( true ) )
 				{
 					bool iteratingVisible = iteratorVisible.NextVisible( true );
-#if UNITY_2018_3_OR_NEWER
-					bool searchPrefabOverridesOnly = ( ( searchParameters.hideNonOverriddenPrefabVariablesInAssets && unityObject.IsAsset() ) || ( searchParameters.hideNonOverriddenPrefabVariablesInScenes && !unityObject.IsAsset() ) ) && PrefabUtility.GetCorrespondingObjectFromSource( unityObject ) != null;
-#endif
+					bool searchPrefabOverridesOnly = ShouldExcludeRedundantPrefabReferences( unityObject );
 					bool enterChildren;
 					do
 					{
@@ -1471,10 +1479,6 @@ private void SearchVariablesWithSerializedObject( ReferenceNode referenceNode, b
 
 						if( !isVisible )
 							enterChildren = false;
-#if UNITY_2018_3_OR_NEWER
-						else if( searchPrefabOverridesOnly && !iterator.prefabOverride )
-							enterChildren = false;
-#endif
 						else
 						{
 							Object propertyValue;
@@ -1542,10 +1546,18 @@ private void SearchVariablesWithSerializedObject( ReferenceNode referenceNode, b
 								// m_RD.texture is a redundant reference that shows up when searching sprites
 								if( !propertyPath.EndsWithFast( "m_RD.texture" ) )
 								{
-									referenceNode.AddLinkTo( searchResult, "Variable: " + propertyPath.Replace( ".Array.data[", "[" ) ); // "arrayVariable.Array.data[0]" becomes "arrayVariable[0]"
+									if( searchPrefabOverridesOnly && !iterator.prefabOverride )
+									{
+										currentSearchResultGroup.NumberOfRedundantReferences++;
+										enterChildren = false;
+									}
+									else
+									{
+										referenceNode.AddLinkTo( searchResult, "Variable: " + propertyPath.Replace( ".Array.data[", "[" ) ); // "arrayVariable.Array.data[0]" becomes "arrayVariable[0]"
 
-									if( searchParameters.searchRefactoring != null && objectsToSearchSet.Contains( propertyValue ) )
-										searchParameters.searchRefactoring( new SerializedPropertyMatch( unityObject, propertyValue, iterator ) );
+										if( searchParameters.searchRefactoring != null && objectsToSearchSet.Contains( propertyValue ) )
+											searchParameters.searchRefactoring( new SerializedPropertyMatch( unityObject, propertyValue, iterator ) );
+									}
 								}
 							}
 						}
@@ -1924,6 +1936,11 @@ private Object GetAddressablesAssetReferenceValue( AssetReference assetReference
 		}
 #endif
 
+		private bool ShouldExcludeRedundantPrefabReferences( Object obj )
+		{
+			return ( ( searchParameters.hideRedundantPrefabReferencesInAssets && obj.IsAsset() ) || ( searchParameters.hideRedundantPrefabReferencesInScenes && !obj.IsAsset() ) ) && obj.GetPrefabParent() != null;
+		}
+
 		// Iterates over all occurrences of specific key-value pairs in string
 		// Example1: #include "VALUE"  valuePrefix=#include, valueWrapperChar="
 		// Example2: "guid": "VALUE"  valuePrefix="guid", valueWrapperChar="

Plugins/AssetUsageDetector/Editor/AssetUsageDetectorWindow.cs

@@ -37,15 +37,25 @@ private enum WindowFilter { AlwaysReturnActive, ReturnActiveIfNotLocked, AlwaysR
 #endif
 		private const string PREFS_CALCULATE_UNUSED_OBJECTS = "AUD_FindUnusedObjs";
 		private const string PREFS_HIDE_DUPLICATE_ROWS = "AUD_HideDuplicates";
-		private const string PREFS_HIDE_NON_OVERRIDDEN_PREFAB_VARIABLES_IN_ASSETS = "AUD_HideRedundantPVariantLinks";
-		private const string PREFS_HIDE_NON_OVERRIDDEN_PREFAB_VARIABLES_IN_SCENES = "AUD_HideRedundantPVarsInScenes";
+		private const string PREFS_HIDE_REDUNDANT_PREFAB_REFERENCES_IN_ASSETS = "AUD_HideRedundantPRefsInAssets";
+		private const string PREFS_HIDE_REDUNDANT_PREFAB_REFERENCES_IN_SCENES = "AUD_HideRedundantPRefsInScenes";
 		private const string PREFS_SHOW_PROGRESS = "AUD_Progress";
 
 		private static readonly GUIContent windowTitle = new GUIContent( "Asset Usage Detector" );
 		private static readonly Vector2 windowMinSize = new Vector2( 325f, 220f );
 
 		private static readonly GUILayoutOption GL_WIDTH_12 = GUILayout.Width( 12f );
 
+		private static readonly GUIContent sharedGUIContent = new GUIContent();
+
+		private readonly GUIContent hideRedundantPrefabReferencesInAssetsLabel = new GUIContent( "Hide redundant prefab references in Assets", "Hides redundant/non-overridden references in prefab variants and nested prefabs. " +
+			"This will help focus on only the references that actually matter. For example:\n\n" +
+			"- Material CloudMat is assigned to prefab Cloud and its variant CloudBig. Since changing Cloud's material will also affect CloudBig, search results won't show CloudBig's reference" );
+		private readonly GUIContent hideRedundantPrefabReferencesInScenesLabel = new GUIContent( "Hide redundant prefab references in Scenes", "Hides redundant/non-overridden references in prefab instances. " +
+			"This will help focus on only the references that actually matter. For example:\n\n" +
+			"- Prefab Healthbar is nested inside prefab Player. An instance of Player exists in the current scene and its Healthbar isn't modified. Since modifying Healthbar in Player prefab will also affect " +
+			"the instance in the scene, search results won't show the instance in the scene while searching for Healthbar's references" );
+
 		private GUIStyle lockButtonStyle;
 
 		private readonly AssetUsageDetector core = new AssetUsageDetector();
@@ -96,8 +106,8 @@ private bool IsLocked
 		private bool searchUnusedMaterialProperties = true;
 		private bool calculateUnusedObjects = false;
 		private bool hideDuplicateRows = true;
-		private bool hideNonOverriddenPrefabVariablesInAssets = true;
-		private bool hideNonOverriddenPrefabVariablesInScenes = false;
+		private bool hideRedundantPrefabReferencesInAssets = false;
+		private bool hideRedundantPrefabReferencesInScenes = false;
 		private bool noAssetDatabaseChanges = false;
 		private bool showDetailedProgressBar = true;
 
@@ -335,8 +345,8 @@ private void ShowAndSearchInternal( IEnumerable<Object> searchObjects, AssetUsag
 #endif
 				calculateUnusedObjects = searchParameters.calculateUnusedObjects;
 				hideDuplicateRows = searchParameters.hideDuplicateRows;
-				hideNonOverriddenPrefabVariablesInAssets = searchParameters.hideNonOverriddenPrefabVariablesInAssets;
-				hideNonOverriddenPrefabVariablesInScenes = searchParameters.hideNonOverriddenPrefabVariablesInScenes;
+				hideRedundantPrefabReferencesInAssets = searchParameters.hideRedundantPrefabReferencesInAssets;
+				hideRedundantPrefabReferencesInScenes = searchParameters.hideRedundantPrefabReferencesInScenes;
 				noAssetDatabaseChanges = searchParameters.noAssetDatabaseChanges;
 				showDetailedProgressBar = searchParameters.showDetailedProgressBar;
 
@@ -419,8 +429,8 @@ private void SavePrefs()
 #endif
 			EditorPrefs.SetBool( PREFS_CALCULATE_UNUSED_OBJECTS, calculateUnusedObjects );
 			EditorPrefs.SetBool( PREFS_HIDE_DUPLICATE_ROWS, hideDuplicateRows );
-			EditorPrefs.SetBool( PREFS_HIDE_NON_OVERRIDDEN_PREFAB_VARIABLES_IN_ASSETS, hideNonOverriddenPrefabVariablesInAssets );
-			EditorPrefs.SetBool( PREFS_HIDE_NON_OVERRIDDEN_PREFAB_VARIABLES_IN_SCENES, hideNonOverriddenPrefabVariablesInScenes );
+			EditorPrefs.SetBool( PREFS_HIDE_REDUNDANT_PREFAB_REFERENCES_IN_ASSETS, hideRedundantPrefabReferencesInAssets );
+			EditorPrefs.SetBool( PREFS_HIDE_REDUNDANT_PREFAB_REFERENCES_IN_SCENES, hideRedundantPrefabReferencesInScenes );
 			EditorPrefs.SetBool( PREFS_SHOW_PROGRESS, showDetailedProgressBar );
 		}
 
@@ -442,8 +452,8 @@ private void LoadPrefs()
 #endif
 			calculateUnusedObjects = EditorPrefs.GetBool( PREFS_CALCULATE_UNUSED_OBJECTS, false );
 			hideDuplicateRows = EditorPrefs.GetBool( PREFS_HIDE_DUPLICATE_ROWS, true );
-			hideNonOverriddenPrefabVariablesInAssets = EditorPrefs.GetBool( PREFS_HIDE_NON_OVERRIDDEN_PREFAB_VARIABLES_IN_ASSETS, true );
-			hideNonOverriddenPrefabVariablesInScenes = EditorPrefs.GetBool( PREFS_HIDE_NON_OVERRIDDEN_PREFAB_VARIABLES_IN_SCENES, false );
+			hideRedundantPrefabReferencesInAssets = EditorPrefs.GetBool( PREFS_HIDE_REDUNDANT_PREFAB_REFERENCES_IN_ASSETS, hideRedundantPrefabReferencesInAssets );
+			hideRedundantPrefabReferencesInScenes = EditorPrefs.GetBool( PREFS_HIDE_REDUNDANT_PREFAB_REFERENCES_IN_SCENES, hideRedundantPrefabReferencesInScenes );
 			showDetailedProgressBar = EditorPrefs.GetBool( PREFS_SHOW_PROGRESS, true );
 		}
 
@@ -571,10 +581,8 @@ private void OnGUI()
 #endif
 				calculateUnusedObjects = WordWrappingToggleLeft( "Calculate unused objects", calculateUnusedObjects );
 				hideDuplicateRows = WordWrappingToggleLeft( "Hide duplicate rows in search results", hideDuplicateRows );
-#if UNITY_2018_3_OR_NEWER
-				hideNonOverriddenPrefabVariablesInAssets = WordWrappingToggleLeft( "Hide non-overridden prefab variables in assets (references found in non-overridden variables of prefab variants/nested prefabs will be hidden)", hideNonOverriddenPrefabVariablesInAssets );
-				hideNonOverriddenPrefabVariablesInScenes = WordWrappingToggleLeft( "Hide non-overridden prefab variables in scenes (references found in non-overridden variables of prefab instances will be hidden)", hideNonOverriddenPrefabVariablesInScenes );
-#endif
+				hideRedundantPrefabReferencesInAssets = WordWrappingToggleLeft( hideRedundantPrefabReferencesInAssetsLabel, hideRedundantPrefabReferencesInAssets );
+				hideRedundantPrefabReferencesInScenes = WordWrappingToggleLeft( hideRedundantPrefabReferencesInScenesLabel, hideRedundantPrefabReferencesInScenes );
 				noAssetDatabaseChanges = WordWrappingToggleLeft( "I haven't modified any assets/scenes since the last search (faster search)", noAssetDatabaseChanges );
 				showDetailedProgressBar = WordWrappingToggleLeft( "Update search progress bar more often (cancelable search) (slower search)", showDetailedProgressBar );
 
@@ -679,6 +687,13 @@ private void EndIndentedGUI( bool isVertical = true )
 		}
 
 		public static bool WordWrappingToggleLeft( string label, bool value )
+		{
+			sharedGUIContent.text = label;
+			sharedGUIContent.tooltip = null;
+			return WordWrappingToggleLeft( sharedGUIContent, value );
+		}
+
+		public static bool WordWrappingToggleLeft( GUIContent label, bool value )
 		{
 			GUILayout.BeginHorizontal();
 			bool result = EditorGUILayout.ToggleLeft( GUIContent.none, value, GL_WIDTH_12 );
@@ -728,8 +743,8 @@ private void InitiateSearch()
 #endif
 				calculateUnusedObjects = calculateUnusedObjects,
 				hideDuplicateRows = hideDuplicateRows,
-				hideNonOverriddenPrefabVariablesInAssets = hideNonOverriddenPrefabVariablesInAssets,
-				hideNonOverriddenPrefabVariablesInScenes = hideNonOverriddenPrefabVariablesInScenes,
+				hideRedundantPrefabReferencesInAssets = hideRedundantPrefabReferencesInAssets,
+				hideRedundantPrefabReferencesInScenes = hideRedundantPrefabReferencesInScenes && searchInAssetsFolder,
 				noAssetDatabaseChanges = noAssetDatabaseChanges,
 				showDetailedProgressBar = showDetailedProgressBar
 			} );

Plugins/AssetUsageDetector/Editor/SearchResult.cs

@@ -23,6 +23,7 @@ internal class SerializableResultGroup
 			public SearchResultGroup.GroupType type;
 			public bool isExpanded;
 			public bool pendingSearch;
+			public int redundantReferences;
 			public SearchResultTreeViewState treeViewState;
 
 			public List<int> initialSerializedNodes;
@@ -576,6 +577,9 @@ public enum GroupType { Assets = 0, Scene = 1, DontDestroyOnLoad = 2, ProjectSet
 		public int NumberOfReferences { get { return references.Count; } }
 		public ReferenceNode this[int index] { get { return references[index]; } }
 
+		public int NumberOfRedundantReferences { get; internal set; }
+		public bool AnyReferencesFound { get { return NumberOfReferences > 0 || NumberOfRedundantReferences > 0; } }
+
 		public SearchResultGroup( string title, GroupType type, bool isExpanded = true, bool pendingSearch = false )
 		{
 			Title = title.StartsWith( "<b>" ) ? title : string.Concat( "<b>", title, "</b>" );
@@ -869,6 +873,9 @@ public float DrawOnGUI( SearchResult searchResult, EditorWindow window, float sc
 
 			if( IsExpanded )
 			{
+				if( NumberOfRedundantReferences > 0 )
+					EditorGUILayout.HelpBox( string.Concat( NumberOfRedundantReferences.ToString(), " redundant prefab reference(s) were skipped. Disable \"Hide redundant prefab references in ", ( Type == GroupType.Scene || Type == GroupType.DontDestroyOnLoad ) ? "Scenes" : "Assets", "\" to see them." ), MessageType.Info );
+
 				if( PendingSearch )
 					GUILayout.Box( "Lazy Search: this scene potentially has some references, hit Refresh to find them", Utilities.BoxGUIStyle );
 				else if( references.Count == 0 )
@@ -1065,6 +1072,7 @@ internal SearchResult.SerializableResultGroup Serialize( Dictionary<ReferenceNod
 				type = Type,
 				isExpanded = IsExpanded,
 				pendingSearch = PendingSearch,
+				redundantReferences = NumberOfRedundantReferences,
 				treeViewState = treeViewState
 			};
 
@@ -1082,6 +1090,7 @@ internal SearchResult.SerializableResultGroup Serialize( Dictionary<ReferenceNod
 		// Deserialize this result group from the serialized data
 		internal void Deserialize( SearchResult.SerializableResultGroup serializedResultGroup, List<ReferenceNode> allNodes )
 		{
+			NumberOfRedundantReferences = serializedResultGroup.redundantReferences;
 			treeViewState = serializedResultGroup.treeViewState;
 
 			if( serializedResultGroup.initialSerializedNodes != null )