feat(Structure): add ObsoleteInspector attribute

The new `[ObsoleteInspector]` attribute is placed above public
inspector parameters in place of the previous `[HideInInspector]`
attribute as hidden deprecated parameters was causing confusion
and this new attribute will display the parameter still but render
the label in a red, italic font so it's obvious there is something
different about the field. The tooltip for the parameter is also
replaced by the obsolete message from the `[System.Obsolete]`
attribute.

Author: thestonefox

Assets/VRTK/Documentation/API.md

@@ -290,8 +290,6 @@ Adds a collection of Object Tooltips to the Controller providing information to
  * **Controller Events:** The controller to read the controller events from. If this is blank then it will attempt to get a controller events script from the same or parent GameObject.
  * **Headset Controller Aware:** The headset controller aware script to use to see if the headset is looking at the controller. If this is blank then it will attempt to get a controller events script from the same or parent GameObject.
  * **Hide When Not In View:** If this is checked then the tooltips will be hidden when the headset is not looking at the controller.
- * **Retry Init Max Tries:** The total number of initialisation attempts to make when waiting for the button transforms to initialise.
- * **Retry Init Counter:** The amount of seconds to wait before re-attempting to initialise the controller tooltips if the button transforms have not been initialised yet.
 
 ### Class Events
 
@@ -4254,7 +4252,6 @@ Determines if the GameObject can be interacted with.
 
  * **Disable When Idle:** If this is checked then the Interactable Object component will be disabled when the Interactable Object is not being interacted with.
  * **Allowed Near Touch Controllers:** Determines which controller can initiate a near touch action.
- * **Touch Highlight Color:** The Color to highlight the object when it is touched.
  * **Allowed Touch Controllers:** Determines which controller can initiate a touch action.
  * **Ignored Colliders:** An array of colliders on the GameObject to ignore when being touched.
  * **Is Grabbable:** Determines if the Interactable Object can be grabbed.

Assets/VRTK/Prefabs/ControllerTooltips/VRTK_ControllerTooltips.cs

@@ -94,13 +94,11 @@ public enum TooltipButtons
         [Tooltip("If this is checked then the tooltips will be hidden when the headset is not looking at the controller.")]
         public bool hideWhenNotInView = true;
 
-        [HideInInspector]
         [System.Obsolete("`VRTK_ControllerTooltips.retryInitMaxTries` has been deprecated as tooltip initialisation now uses the `VRTK_TrackedController.ControllerModelAvailable` event.")]
-        [Tooltip("The total number of initialisation attempts to make when waiting for the button transforms to initialise.")]
+        [ObsoleteInspector]
         public int retryInitMaxTries = 10;
-        [HideInInspector]
         [System.Obsolete("`VRTK_ControllerTooltips.retryInitCounter` has been deprecated as tooltip initialisation now uses the `VRTK_TrackedController.ControllerModelAvailable` event.")]
-        [Tooltip("The amount of seconds to wait before re-attempting to initialise the controller tooltips if the button transforms have not been initialised yet.")]
+        [ObsoleteInspector]
         public float retryInitCounter = 0.1f;
 
         /// <summary>

Assets/VRTK/Prefabs/SnapDropZone/VRTK_SnapDropZone.cs

@@ -2,7 +2,6 @@
 namespace VRTK
 {
     using UnityEngine;
-    using System;
     using System.Collections;
     using System.Collections.Generic;
     using Highlighters;
@@ -80,14 +79,13 @@ public enum SnapTypes
         [Tooltip("If this is checked then the drop zone highlight section will be displayed in the scene editor window.")]
         public bool displayDropZoneInEditor = true;
 
-        [Tooltip("The GameObject to snap into the dropzone when the drop zone is enabled. The Interactable Object must be valid in any given policy list to snap.")]
-        [Obsolete("`VRTK_SnapDropZone.defaultSnappedObject` has been replaced with the `VRTK_SnapDropZone.defaultSnappedInteractableObject`. This parameter will be removed in a future version of VRTK.")]
-        [HideInInspector]
-        public GameObject defaultSnappedObject;
-
         [Tooltip("The Interactable Object to snap into the dropzone when the drop zone is enabled. The Interactable Object must be valid in any given policy list to snap.")]
         public VRTK_InteractableObject defaultSnappedInteractableObject;
 
+        [System.Obsolete("`VRTK_SnapDropZone.defaultSnappedObject` has been replaced with the `VRTK_SnapDropZone.defaultSnappedInteractableObject`. This parameter will be removed in a future version of VRTK.")]
+        [ObsoleteInspector]
+        public GameObject defaultSnappedObject;
+
         /// <summary>
         /// Emitted when a valid interactable object enters the snap drop zone trigger collider.
         /// </summary>

Assets/VRTK/Source/Editor/Attributes/ObsoleteInspectorDrawer.cs

@@ -0,0 +1,17 @@
+namespace VRTK
+{
+    using UnityEngine;
+    using UnityEditor;
+    using System;
+
+    [CustomPropertyDrawer(typeof(ObsoleteInspectorAttribute))]
+    class ObsoleteInspectorDrawer : PropertyDrawer
+    {
+        public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+        {
+            ObsoleteAttribute obsoleteAttribute = (ObsoleteAttribute)Attribute.GetCustomAttribute(fieldInfo, typeof(ObsoleteAttribute));
+            EditorStyles.label.richText = true;
+            EditorGUI.PropertyField(position, property, new GUIContent("<color=red><i>" + label.text + "</i></color>", "**OBSOLETE**\n\n" + obsoleteAttribute.Message), true);
+        }
+    }
+}

Assets/VRTK/Source/Editor/Attributes/ObsoleteInspectorDrawer.cs.meta

@@ -22,17 +22,17 @@ public class VRTK_AxisScaleGrabAction : VRTK_BaseGrabAction
         public float ungrabDistance = 1f;
         [Tooltip("Locks the specified checked axes so they won't be scaled")]
         public Vector3State lockAxis = Vector3State.False;
+        [Tooltip("If checked all the axes will be scaled together (unless locked)")]
+        public bool uniformScaling = false;
         [System.Obsolete("`VRTK_AxisScaleGrabAction.lockXAxis` has been replaced with the `VRTK_AxisScaleGrabAction.lockAxis`. This parameter will be removed in a future version of VRTK.")]
-        [HideInInspector]
+        [ObsoleteInspector]
         public bool lockXAxis = false;
         [System.Obsolete("`VRTK_AxisScaleGrabAction.lockYAxis` has been replaced with the `VRTK_AxisScaleGrabAction.lockAxis`. This parameter will be removed in a future version of VRTK.")]
-        [HideInInspector]
+        [ObsoleteInspector]
         public bool lockYAxis = false;
         [System.Obsolete("`VRTK_AxisScaleGrabAction.lockZAxis` has been replaced with the `VRTK_AxisScaleGrabAction.lockAxis`. This parameter will be removed in a future version of VRTK.")]
-        [HideInInspector]
+        [ObsoleteInspector]
         public bool lockZAxis = false;
-        [Tooltip("If checked all the axes will be scaled together (unless locked)")]
-        public bool uniformScaling = false;
 
         protected Vector3 initialScale;
         protected float initalLength;

Assets/VRTK/Source/Scripts/Interactions/Interactables/SecondaryControllerGrabActions/VRTK_AxisScaleGrabAction.cs

@@ -155,18 +155,17 @@ public enum ValidDropTypes
         [Tooltip("Determines which controller can initiate a near touch action.")]
         public AllowedController allowedNearTouchControllers = AllowedController.Both;
 
-        [System.Obsolete("`VRTK_InteractableObject.touchHighlightColor` has been replaced with `VRTK_InteractObjectHighlighter.touchHighlight`. This parameter will be removed in a future version of VRTK.")]
-        [Tooltip("The Color to highlight the object when it is touched.")]
-        [HideInInspector]
-        public Color touchHighlightColor = Color.clear;
-
         [Header("Touch Settings")]
 
         [Tooltip("Determines which controller can initiate a touch action.")]
         public AllowedController allowedTouchControllers = AllowedController.Both;
         [Tooltip("An array of colliders on the GameObject to ignore when being touched.")]
         public Collider[] ignoredColliders;
 
+        [System.Obsolete("`VRTK_InteractableObject.touchHighlightColor` has been replaced with `VRTK_InteractObjectHighlighter.touchHighlight`. This parameter will be removed in a future version of VRTK.")]
+        [ObsoleteInspector]
+        public Color touchHighlightColor = Color.clear;
+
         [Header("Grab Settings")]
 
         [Tooltip("Determines if the Interactable Object can be grabbed.")]

Assets/VRTK/Source/Scripts/Interactions/Interactables/VRTK_InteractableObject.cs

@@ -0,0 +1,7 @@
+namespace VRTK
+{
+    using UnityEngine;
+    public class ObsoleteInspectorAttribute : PropertyAttribute
+    {
+    }
+}

Assets/VRTK/Source/Scripts/Internal/Attributes/ObsoleteInspectorAttribute.cs

@@ -3,7 +3,6 @@ namespace VRTK
 {
     using UnityEngine;
     using System.Collections;
-    using System;
 #if UNITY_5_5_OR_NEWER
     using UnityEngine.AI;
 #endif
@@ -49,8 +48,8 @@ public class VRTK_BasicTeleport : MonoBehaviour
         [Tooltip("An optional NavMeshData object that will be utilised for limiting the teleport to within any scene NavMesh.")]
         public VRTK_NavMeshData navMeshData;
 
-        [HideInInspector]
-        [Obsolete("`VRTK_BasicTeleport.navMeshLimitDistance` is no longer used, use `VRTK_BasicTeleport.processNavMesh` instead. This parameter will be removed in a future version of VRTK.")]
+        [System.Obsolete("`VRTK_BasicTeleport.navMeshLimitDistance` is no longer used, use `VRTK_BasicTeleport.processNavMesh` instead. This parameter will be removed in a future version of VRTK.")]
+        [ObsoleteInspector]
         public float navMeshLimitDistance = 0f;
 
         /// <summary>