MERGE: develop => stable.

Author: Rene Damm

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -512,6 +512,8 @@ void CheckHTMLFileLinkConsistency(string htmlFile, List<string> unresolvedLinks,
         }
     }
 
+    ////TODO: add verification of *online* links to this; probably prone to instability and maybe they shouldn't fail tests but would
+    ////      be great to have some way of diagnosing links that have gone stale
     [Test]
     [Category("API")]
 #if UNITY_EDITOR_OSX

Assets/Tests/InputSystem/CoreTests_Actions.cs

@@ -739,6 +739,42 @@ public void Actions_CanReadValueFromAction_InCallback()
         Assert.That(receivedValue, Is.EqualTo(1).Within(0.00001));
     }
 
+    [Test]
+    [Category("Actions")]
+    public void Actions_CanReadValueFromAction_InCallback_AsButton()
+    {
+        InputSystem.settings.defaultButtonPressPoint = 0.5f;
+
+        var action = new InputAction(binding: "<Gamepad>/leftTrigger");
+        var gamepad = InputSystem.AddDevice<Gamepad>();
+
+        action.Enable();
+
+        bool? receivedValue = null;
+        action.performed +=
+            ctx =>
+        {
+            Assert.That(receivedValue, Is.Null);
+            receivedValue = ctx.ReadValueAsButton();
+        };
+
+        Set(gamepad.leftTrigger, 0.25f);
+
+        Assert.That(receivedValue, Is.False);
+
+        receivedValue = null;
+
+        Set(gamepad.leftTrigger, 0.75f);
+
+        Assert.That(receivedValue, Is.True);
+
+        receivedValue = null;
+
+        Set(gamepad.leftTrigger, 0.15f);
+
+        Assert.That(receivedValue, Is.False);
+    }
+
     // Some code needs to be able to just generically transfer values from A to B. For this, the
     // generic ReadValue<TValue>() API isn't sufficient.
     [Test]
@@ -1161,53 +1197,33 @@ public void Actions_CanByPassControlActuationChecks_UsingPasshtroughAction()
         var action = new InputAction(type: InputActionType.PassThrough, binding: "<Gamepad>/*stick");
         action.Enable();
 
-        using (var trace = new InputActionTrace())
+        using (var trace = new InputActionTrace(action))
         {
-            trace.SubscribeTo(action);
-
             Set(gamepad.leftStick, new Vector2(0.123f, 0.234f));
 
-            var actions = trace.ToArray();
-            Assert.That(actions, Has.Length.EqualTo(1));
-            Assert.That(actions[0].phase, Is.EqualTo(InputActionPhase.Performed));
-            Assert.That(actions[0].control, Is.SameAs(gamepad.leftStick));
-            Assert.That(actions[0].ReadValue<Vector2>(),
-                Is.EqualTo(new StickDeadzoneProcessor().Process(new Vector2(0.123f, 0.234f)))
-                    .Using(Vector2EqualityComparer.Instance));
+            Assert.That(trace,
+                Performed(action, gamepad.leftStick, new StickDeadzoneProcessor().Process(new Vector2(0.123f, 0.234f))));
 
             trace.Clear();
 
             Set(gamepad.leftStick, new Vector2(0.234f, 0.345f));
 
-            actions = trace.ToArray();
-            Assert.That(actions, Has.Length.EqualTo(1));
-            Assert.That(actions[0].phase, Is.EqualTo(InputActionPhase.Performed));
-            Assert.That(actions[0].control, Is.SameAs(gamepad.leftStick));
-            Assert.That(actions[0].ReadValue<Vector2>(),
-                Is.EqualTo(new StickDeadzoneProcessor().Process(new Vector2(0.234f, 0.345f)))
-                    .Using(Vector2EqualityComparer.Instance));
+            Assert.That(trace,
+                Performed(action, gamepad.leftStick, new StickDeadzoneProcessor().Process(new Vector2(0.234f, 0.345f))));
 
             trace.Clear();
 
             Set(gamepad.rightStick, new Vector2(0.123f, 0.234f));
 
-            actions = trace.ToArray();
-            Assert.That(actions, Has.Length.EqualTo(1));
-            Assert.That(actions[0].phase, Is.EqualTo(InputActionPhase.Performed));
-            Assert.That(actions[0].control, Is.SameAs(gamepad.rightStick));
-            Assert.That(actions[0].ReadValue<Vector2>(),
-                Is.EqualTo(new StickDeadzoneProcessor().Process(new Vector2(0.123f, 0.234f)))
-                    .Using(Vector2EqualityComparer.Instance));
+            Assert.That(trace,
+                Performed(action, gamepad.rightStick, new StickDeadzoneProcessor().Process(new Vector2(0.123f, 0.234f))));
 
             trace.Clear();
 
             Set(gamepad.rightStick, Vector2.zero);
 
-            actions = trace.ToArray();
-            Assert.That(actions, Has.Length.EqualTo(1));
-            Assert.That(actions[0].phase, Is.EqualTo(InputActionPhase.Performed));
-            Assert.That(actions[0].control, Is.SameAs(gamepad.rightStick));
-            Assert.That(actions[0].ReadValue<Vector2>(), Is.EqualTo(Vector2.zero).Using(Vector2EqualityComparer.Instance));
+            Assert.That(trace,
+                Performed(action, gamepad.rightStick, Vector2.zero));
         }
     }
 
@@ -2784,6 +2800,46 @@ public void Actions_CanAddProcessorsToBindings()
         Assert.That(receivedVector.Value.y, Is.EqualTo(0.5678).Within(0.00001));
     }
 
+    // https://fogbugz.unity3d.com/f/cases/1207082/
+    [Test]
+    [Category("Actions")]
+    public void Actions_CanAddProcessorsToCompositeBindings()
+    {
+        var keyboard = InputSystem.AddDevice<Keyboard>();
+
+        var action = new InputAction();
+        action.AddCompositeBinding("2DVector", processors: "invertVector2(invertX=true,invertY=true)")
+            .With("Up", "<Keyboard>/w")
+            .With("Down", "<Keyboard>/s")
+            .With("Left", "<Keyboard>/a")
+            .With("Right", "<Keyboard>/d");
+
+        action.Enable();
+
+        // Left -> Right.
+        Press(keyboard.aKey);
+
+        Assert.That(action.ReadValue<Vector2>(), Is.EqualTo(new Vector2(1, 0)));
+
+        // Right -> Left.
+        Release(keyboard.aKey);
+        Press(keyboard.dKey);
+
+        Assert.That(action.ReadValue<Vector2>(), Is.EqualTo(new Vector2(-1, 0)));
+
+        // Up -> Down.
+        Release(keyboard.dKey);
+        Press(keyboard.wKey);
+
+        Assert.That(action.ReadValue<Vector2>(), Is.EqualTo(new Vector2(0, -1)));
+
+        // Down -> Up.
+        Release(keyboard.wKey);
+        Press(keyboard.sKey);
+
+        Assert.That(action.ReadValue<Vector2>(), Is.EqualTo(new Vector2(0, 1)));
+    }
+
     [Test]
     [Category("Actions")]
     public void Actions_CanAddScaleProcessor()
@@ -3588,6 +3644,69 @@ public void Actions_CanEnableActionThatHasNoControls()
         Assert.That(action2.enabled, Is.True);
     }
 
+    [Test]
+    [Category("Actions")]
+    public void Actions_CanMixEnablingSingleActionsAndEntireActionMaps()
+    {
+        var gamepad = InputSystem.AddDevice<Gamepad>();
+
+        var asset = ScriptableObject.CreateInstance<InputActionAsset>();
+        var map1 = new InputActionMap("map1");
+        var map2 = new InputActionMap("map2");
+        var action1 = map1.AddAction("action1", binding: "<Gamepad>/buttonSouth");
+        var action2 = map1.AddAction("action2", binding: "<Gamepad>/buttonNorth");
+        var action3 = map2.AddAction("action3", binding: "<Gamepad>/buttonSouth");
+        var action4 = map2.AddAction("action4", binding: "<Gamepad>/buttonNorth");
+        asset.AddActionMap(map1);
+        asset.AddActionMap(map2);
+
+        action3.Enable();
+        map1.Enable();
+
+        using (var trace1 = new InputActionTrace(action1))
+        using (var trace2 = new InputActionTrace(action2))
+        using (var trace3 = new InputActionTrace(action3))
+        using (var trace4 = new InputActionTrace(action4))
+        {
+            PressAndRelease(gamepad.buttonSouth);
+
+            Assert.That(trace1, Started(action1).AndThen(Performed(action1)).AndThen(Canceled(action1)));
+            Assert.That(trace2, Is.Empty);
+            Assert.That(trace3, Started(action3).AndThen(Performed(action3)).AndThen(Canceled(action3)));
+            Assert.That(trace4, Is.Empty);
+
+            trace1.Clear();
+            trace2.Clear();
+            trace3.Clear();
+            trace4.Clear();
+
+            map1.Disable();
+            map2.Enable();
+
+            PressAndRelease(gamepad.buttonSouth);
+
+            Assert.That(trace1, Is.Empty);
+            Assert.That(trace2, Is.Empty);
+            Assert.That(trace3, Started(action3).AndThen(Performed(action3)).AndThen(Canceled(action3)));
+            Assert.That(trace4, Is.Empty);
+
+            trace1.Clear();
+            trace2.Clear();
+            trace3.Clear();
+            trace4.Clear();
+
+            map1.Enable();
+            map2.Disable();
+
+            PressAndRelease(gamepad.buttonSouth);
+
+            Assert.That(trace1, Started(action1).AndThen(Performed(action1)).AndThen(Canceled(action1)));
+            Assert.That(trace2, Is.Empty);
+            Assert.That(trace3, Is.Empty);
+            Assert.That(trace4, Is.Empty);
+        }
+    }
+
     [Test]
     [Category("Actions")]
     public void Actions_CanTargetSingleDeviceWithMultipleActions()
@@ -4762,7 +4881,7 @@ public void Actions_WhenGettingDisplayTextForBindingsOnAction_InteractionsAreSho
 
         // Can suppress.
         Assert.That(action1.GetBindingDisplayString(InputBinding.DisplayStringOptions.DontIncludeInteractions),
-            Is.EqualTo("Hold " + GamepadState.ButtonSouthShortDisplayName));
+            Is.EqualTo(GamepadState.ButtonSouthShortDisplayName));
     }
 
     [Test]
@@ -5724,7 +5843,6 @@ public void Actions_CompositesInDifferentMapsTiedToSameControlsWork()
         asset.AddActionMap(map2);
         asset.Enable();
 
-
         InputControl performedControl1 = null;
         InputControl performedControl2 = null;
         action1.performed += ctx => performedControl1 = ctx.control;
@@ -6266,6 +6384,28 @@ public void Actions_CanEnableAndDisableEntireMap()
         Assert.That(action2.enabled, Is.False);
     }
 
+    // https://fogbugz.unity3d.com/f/cases/1213085 (bindings that refer to non-existent actions should not lead to errors)
+    [Test]
+    [Category("Actions")]
+    public void Actions_CanEnableAndDisableEntireMap_EvenWhenBindingsReferToNonExistentActions()
+    {
+        var gamepad = InputSystem.AddDevice<Gamepad>();
+
+        var map = new InputActionMap();
+        map.AddAction("action", binding: "<Gamepad>/buttonSouth");
+        map.AddBinding("<Gamepad>/buttonNorth", action: "DoesNotExist");
+
+        // Also try the same for a composite binding.
+        map.AddBinding(new InputBinding { path = "1DAxis", isComposite = true, action = "DoesNotExist" });
+        map.AddBinding(new InputBinding { name = "Positive", path = "<Gamepad>/leftTrigger", isPartOfComposite = true });
+        map.AddBinding(new InputBinding { name = "Negative", path = "<Gamepad>/rightTrigger", isPartOfComposite = true });
+
+        Assert.That(() => map.Enable(), Throws.Nothing);
+
+        Assert.That(() => Press(gamepad.buttonNorth), Throws.Nothing);
+        Assert.That(() => Press(gamepad.leftTrigger), Throws.Nothing);
+    }
+
     [Test]
     [Category("Actions")]
     public void Actions_CanEnableAndDisableSingleActionFromMap()

Assets/Tests/InputSystem/CoreTests_Actions_Interactions.cs

@@ -1,18 +1,21 @@
 using System.Linq;
 using NUnit.Framework;
+using UnityEngine;
 using UnityEngine.InputSystem;
 using UnityEngine.InputSystem.Interactions;
 using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.Utilities;
-using UnityEngine.InputSystem.XR;
 using UnityEngine.Scripting;
 
 internal partial class CoreTests
 {
     [Preserve]
     class InteractionThatOnlyPerforms : IInputInteraction<float>
     {
+        // Get rid of unused field warning.
+        #pragma warning disable CS0649
         public bool stayPerformed;
+        #pragma warning restore CS0649
 
         public void Process(ref InputInteractionContext context)
         {
@@ -187,6 +190,47 @@ public void Actions_CanPerformPressInteraction()
         }
     }
 
+    // https://fogbugz.unity3d.com/f/cases/1205285/
+    [Test]
+    [Category("Actions")]
+    public void Actions_CanPerformPressInteraction_AndTriggerInteractionResetInCallback()
+    {
+        var keyboard = InputSystem.AddDevice<Keyboard>();
+
+        var asset = ScriptableObject.CreateInstance<InputActionAsset>();
+        var map1 = new InputActionMap("map1");
+        var map2 = new InputActionMap("map2");
+        asset.AddActionMap(map1);
+        asset.AddActionMap(map2);
+
+        var action1 = map1.AddAction("action1");
+        var action2 = map2.AddAction("action2");
+        // PressInteraction used to set some local state *after* trigger callbacks. This meant that if the
+        // callback triggered a Reset() call, PressInteraction would then overwrite state from the reset.
+        action1.AddBinding("<Keyboard>/a", interactions: "press(behavior=0)");
+        action2.AddBinding("<Keyboard>/b", interactions: "press(behavior=0)");
+
+        action1.performed += _ => { map1.Disable(); map2.Enable(); };
+        action2.performed += _ => { map2.Disable(); map1.Enable(); };
+
+        map1.Enable();
+
+        PressAndRelease(keyboard.aKey);
+
+        Assert.That(map1.enabled, Is.False);
+        Assert.That(map2.enabled, Is.True);
+
+        PressAndRelease(keyboard.bKey);
+
+        Assert.That(map1.enabled, Is.True);
+        Assert.That(map2.enabled, Is.False);
+
+        PressAndRelease(keyboard.aKey);
+
+        Assert.That(map1.enabled, Is.False);
+        Assert.That(map2.enabled, Is.True);
+    }
+
     [Test]
     [Category("Actions")]
     public void Actions_CanPerformHoldInteraction()

Assets/Tests/InputSystem/CoreTests_Editor.cs

@@ -2210,6 +2210,31 @@ public void Editor_InputEventsOccurringWhileGoingIntoPlayMode_AreDiscarded()
         Assert.That(runtime.m_EventCount, Is.EqualTo(0));
     }
 
+    [Test]
+    [Category("Editor")]
+    public void Editor_LeavingPlayMode_DestroysAllActionStates()
+    {
+        InputSystem.AddDevice<Gamepad>();
+
+        // Enter play mode.
+        InputSystem.OnPlayModeChange(PlayModeStateChange.ExitingEditMode);
+        InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredPlayMode);
+
+        var action = new InputAction(binding: "<Gamepad>/buttonSouth");
+        action.Enable();
+
+        Assert.That(InputActionState.s_GlobalList.length, Is.EqualTo(1));
+        Assert.That(InputSystem.s_Manager.m_StateChangeMonitors.Length, Is.GreaterThan(0));
+        Assert.That(InputSystem.s_Manager.m_StateChangeMonitors[0].count, Is.EqualTo(1));
+
+        // Exit play mode.
+        InputSystem.OnPlayModeChange(PlayModeStateChange.ExitingPlayMode);
+        InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredEditMode);
+
+        Assert.That(InputActionState.s_GlobalList.length, Is.Zero);
+        Assert.That(InputSystem.s_Manager.m_StateChangeMonitors[0].listeners[0].control, Is.Null); // Won't get removed, just cleared.
+    }
+
     ////TODO: tests for InputAssetImporter; for this we need C# mocks to be able to cut us off from the actual asset DB
 }
 #endif // UNITY_EDITOR