Merge branch 'develop' into isxb-1269-fix-inputactions-processor-in-the-inspector

Author: bmalrat

Packages/com.unity.inputsystem/DocCodeSamples.Tests.meta

@@ -0,0 +1,16 @@
+{
+    "name": "Unity.InputSystem.DocCodeSamples",
+    "rootNamespace": "",
+    "references": [
+        "GUID:75469ad4d38634e559750d17036d5f7c"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": true,
+    "precompiledReferences": [],
+    "autoReferenced": false,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Packages/com.unity.inputsystem/DocCodeSamples.Tests/DocCodeSamples.asmdef

@@ -0,0 +1,53 @@
+using UnityEngine;
+using UnityEngine.InputSystem;
+
+namespace DocCodeSamples.Tests
+{
+    internal class GamepadExample : MonoBehaviour
+    {
+        void Start()
+        {
+            // Print all connected gamepads
+            Debug.Log(string.Join("\n", Gamepad.all));
+        }
+
+        void Update()
+        {
+            var gamepad = Gamepad.current;
+
+            // No gamepad connected.
+            if (gamepad == null)
+            {
+                return;
+            }
+
+            // Check if "Button North" was pressed this frame
+            if (gamepad.buttonNorth.wasPressedThisFrame)
+            {
+                Debug.Log("Button North was pressed");
+            }
+
+            // Check if the button control is being continuously actuated and read its value
+            if (gamepad.rightTrigger.IsActuated())
+            {
+                Debug.Log("Right trigger value: " + gamepad.rightTrigger.ReadValue());
+            }
+
+            // Read left stick value and perform some code based on the value
+            Vector2 move = gamepad.leftStick.ReadValue();
+            {
+                // Use the Vector2 move for the game logic here
+            }
+
+            // Creating haptic feedback while "Button South" is pressed and stopping it when released.
+            if (gamepad.buttonSouth.wasPressedThisFrame)
+            {
+                gamepad.SetMotorSpeeds(0.2f, 1.0f);
+            }
+            else if (gamepad.buttonSouth.wasReleasedThisFrame)
+            {
+                gamepad.ResetHaptics();
+            }
+        }
+    }
+}

Packages/com.unity.inputsystem/DocCodeSamples.Tests/DocCodeSamples.asmdef.meta

@@ -0,0 +1,48 @@
+using UnityEngine;
+using UnityEngine.InputSystem;
+
+namespace DocCodeSamples.Tests
+{
+    internal class GamepadHapticsExample : MonoBehaviour
+    {
+        bool hapticsArePaused = false;
+
+        void Update()
+        {
+            var gamepad = Gamepad.current;
+
+            // No gamepad connected, no need to continue.
+            if (gamepad == null)
+                return;
+
+            float leftTrigger = gamepad.leftTrigger.ReadValue();
+            float rightTrigger = gamepad.rightTrigger.ReadValue();
+
+            // Only set motor speeds if haptics were not paused and if trigger is actuated.
+            // Both triggers must be actuated past 0.2f to start haptics.
+            if (!hapticsArePaused &&
+                (gamepad.leftTrigger.IsActuated() || gamepad.rightTrigger.IsActuated()))
+                gamepad.SetMotorSpeeds(
+                    leftTrigger < 0.2f ? 0.0f : leftTrigger,
+                    rightTrigger < 0.2f ? 0.0f : rightTrigger);
+
+            // Toggle haptics "playback" when "Button South" is pressed.
+            // Notice that if you release the triggers after pausing,
+            // and press the button again, haptics will resume.
+            if (gamepad.buttonSouth.wasPressedThisFrame)
+            {
+                if (hapticsArePaused)
+                    gamepad.ResumeHaptics();
+                else
+                    gamepad.PauseHaptics();
+
+                hapticsArePaused = !hapticsArePaused;
+            }
+
+            // Notice that if you release the triggers after pausing,
+            // and press the Start button, haptics will be reset.
+            if (gamepad.startButton.wasPressedThisFrame)
+                gamepad.ResetHaptics();
+        }
+    }
+}

Packages/com.unity.inputsystem/DocCodeSamples.Tests/GamepadExample.cs

@@ -10,7 +10,7 @@ namespace UnityEngine.InputSystem.Controls
     /// An axis that has a trigger point beyond which it is considered to be pressed.
     /// </summary>
     /// <remarks>
-    /// By default stored as a single bit. In that format, buttons will only yield 0
+    /// By default, stored as a single bit. In that format, buttons will only yield 0
     /// and 1 as values. However, buttons return are <see cref="AxisControl"/>s and
     /// yield full floating-point values and may thus have a range of values. See
     /// <see cref="pressPoint"/> for how button presses on such buttons are handled.
@@ -46,6 +46,9 @@ public class ButtonControl : AxisControl
         ///
         /// <example>
         /// <code>
+        /// using UnityEngine;
+        /// using UnityEngine.InputSystem.Controls;
+        ///
         /// public class MyDevice : InputDevice
         /// {
         ///     [InputControl(parameters = "pressPoint=0.234")]
@@ -56,25 +59,38 @@ public class ButtonControl : AxisControl
         /// </code>
         /// </example>
         /// </remarks>
-        /// <seealso cref="InputSettings.defaultButtonPressPoint"/>
-        /// <seealso cref="pressPointOrDefault"/>
-        /// <seealso cref="isPressed"/>
         public float pressPoint = -1;
 
         /// <summary>
         /// Return <see cref="pressPoint"/> if set, otherwise return <see cref="InputSettings.defaultButtonPressPoint"/>.
         /// </summary>
         /// <value>Effective value to use for press point thresholds.</value>
-        /// <seealso cref="InputSettings.defaultButtonPressPoint"/>
         public float pressPointOrDefault => pressPoint > 0 ? pressPoint : s_GlobalDefaultButtonPressPoint;
 
         /// <summary>
-        /// Default-initialize the control.
+        /// Default-initialize the button control.
         /// </summary>
         /// <remarks>
-        /// The default format for the control is <see cref="InputStateBlock.FormatBit"/>.
-        /// The control's minimum value is set to 0 and the maximum value to 1.
+        /// The default format for the button control is <see cref="InputStateBlock.FormatBit"/>.
+        /// The button control's minimum value is set to 0 and the maximum value to 1.
         /// </remarks>
+        /// <example>
+        /// <code>
+        /// using UnityEngine;
+        /// using UnityEngine.InputSystem.Controls;
+        ///
+        /// public class ButtonControlExample : MonoBehaviour
+        /// {
+        ///     void Start()
+        ///     {
+        ///         var myButton = new ButtonControl();
+        ///     }
+        ///
+        ///     //...
+        /// }
+        /// </code>
+        /// </example>
+        /// <seealso cref="AxisControl"/>
         public ButtonControl()
         {
             m_StateBlock.format = InputStateBlock.FormatBit;
@@ -85,10 +101,39 @@ public ButtonControl()
         /// <summary>
         /// Whether the given value would be considered pressed for this button.
         /// </summary>
-        /// <param name="value">Value for the button.</param>
+        /// <param name="value">Value to check for if the button would be considered pressed or not.</param>
         /// <returns>True if <paramref name="value"/> crosses the threshold to be considered pressed.</returns>
-        /// <seealso cref="pressPoint"/>
-        /// <seealso cref="InputSettings.defaultButtonPressPoint"/>
+        /// <remarks>
+        /// The default format for the control is <see cref="InputStateBlock.FormatBit"/>.
+        /// The control's minimum value is set to 0 and the maximum value to 1.
+        /// See <see cref="InputSettings.defaultButtonPressPoint"/> for the default press point.
+        /// </remarks>
+        /// <example>
+        /// <code>
+        /// using UnityEngine;
+        /// using UnityEngine.InputSystem.Controls;
+        ///
+        /// public class IsValueConsideredPressedExample : MonoBehaviour
+        /// {
+        ///     void Start()
+        ///     {
+        ///         var myButton = new ButtonControl();
+        ///         var valueToTest = 0.5f;
+        ///
+        ///         if (myButton.IsValueConsideredPressed(valueToTest))
+        ///         {
+        ///             Debug.Log("myButton is considered pressed at: " + valueToTest.ToString());
+        ///         }
+        ///         else
+        ///         {
+        ///             Debug.Log("myButton is not considered pressed at: " + valueToTest.ToString());
+        ///         }
+        ///     }
+        ///
+        ///     //...
+        /// }
+        /// </code>
+        /// </example>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public new bool IsValueConsideredPressed(float value)
         {
@@ -149,9 +194,6 @@ public ButtonControl()
         /// ]]>
         /// </code>
         /// </example>
-        /// <seealso cref="InputSettings.defaultButtonPressPoint"/>
-        /// <seealso cref="pressPoint"/>
-        /// <seealso cref="InputSystem.onAnyButtonPress"/>
         public bool isPressed
         {
             get
@@ -276,8 +318,8 @@ public bool wasPressedThisFrame
         /// {
         ///     void Update()
         ///     {
-        ///         bool buttonPressed = Gamepad.current.aButton.wasReleasedThisFrame;
-        ///         bool spaceKeyPressed = Keyboard.current.spaceKey.wasReleasedThisFrame;
+        ///         bool buttonReleased = Gamepad.current.aButton.wasReleasedThisFrame;
+        ///         bool spaceKeyReleased = Keyboard.current.spaceKey.wasReleasedThisFrame;
         ///     }
         /// }
         /// </code>