Change to disable PWA actions when using it in PlayerInput

Author: jfreire-unity

Assets/Tests/InputSystem/CoreTests_ProjectWideActions.cs

@@ -4,11 +4,11 @@
 using NUnit.Framework;
 using UnityEngine.InputSystem;
 using UnityEngine.TestTools;
+using UnityEngine;
 
 #if UNITY_EDITOR
 using System.IO;
 using UnityEditor;
-using UnityEngine;
 using UnityEngine.InputSystem.Editor;
 #endif // UNITY_EDITOR
 
@@ -101,10 +101,10 @@ public void ProjectWideActions_IsAutomaticallyAssignedFromPersistedAsset_WhenRun
         Assert.That(InputSystem.actions, Is.Not.Null);
 
         // In editor play-mode we may as well verify that the asset has the expected name
-        #if UNITY_EDITOR
+#if UNITY_EDITOR
         var expectedName = InputActionImporter.NameFromAssetPath(AssetDatabase.GetAssetPath(InputSystem.actions));
         Assert.That(InputSystem.actions.name, Is.EqualTo(expectedName));
-        #endif
+#endif
     }
 
     [Test]
@@ -140,6 +140,51 @@ public void ProjectWideActions_AppearInEnabledActions()
 
         // TODO Modifying the actions object after being assigned should also enable newly added actions?
     }
+
+    [Category(TestCategory)]
+    [Test]
+    // Test that will make sure that a PlayerInput component using project wide actions will:
+    // - Have the only default action map set enabled, and all others disabled.
+    // - Have all action maps of project-wide actions disabled, if there's no default action map selected.
+    [TestCase("Player", true)]
+    [TestCase(null, false)]
+    public void ProjectWideActions_AreDisabledWithPlayerInput(string actionMapName, bool expectedResult)
+    {
+        var keyboard = InputSystem.AddDevice<Keyboard>();
+        var go = new GameObject("PlayerInput");
+
+        go.SetActive(false);
+        var playerInput = go.AddComponent<PlayerInput>();
+        playerInput.actions = InputSystem.actions;
+        // Default action map to be enabled. All others are expected to be disabled since InputSystem.actions.Disable()
+        // will be called.
+        playerInput.defaultActionMap = actionMapName;
+
+        #if UNITY_EDITOR
+        InputSystem.OnPlayModeChange(PlayModeStateChange.ExitingEditMode);
+        #endif
+
+        // This makes sure to call PlayerInput.OnEnable()
+        go.SetActive(true);
+
+        Assert.That(ReferenceEquals(playerInput.actions, InputSystem.actions));
+        Assert.That(playerInput.actions.enabled, Is.EqualTo(expectedResult));
+
+        #if UNITY_EDITOR
+        // This mimics the behavior of entering play-mode, which will check if InputSystem.EnableActions() should
+        // be called.
+        InputSystem.OnPlayModeChange(PlayModeStateChange.EnteredPlayMode);
+        #endif
+
+        if (actionMapName != null)
+            Assert.That(playerInput.currentActionMap.enabled, Is.EqualTo(expectedResult));
+
+        Assert.That(InputSystem.actions.FindActionMap("Player").enabled, Is.EqualTo(expectedResult));
+        Assert.That(InputSystem.actions.FindActionMap("UI").enabled, Is.False);
+
+        //NOTE: Asset actions will be considered enabled even if a single action map is enabled
+        Assert.That(playerInput.actions.enabled, Is.EqualTo(expectedResult));
+    }
 }
 
 #endif

Assets/Tests/InputSystem/Plugins/PlayerInputTests.cs

@@ -55,7 +55,7 @@ public void PlayerInput_CanInstantiatePlayer()
 
         Assert.That(player, Is.Not.Null);
         Assert.That(player.playerIndex, Is.EqualTo(0));
-        Assert.That(player.actions.actionMaps.Count, Is.EqualTo(prefabPlayerInput.actions.actionMaps.Count));
+        Assert.That(player.actions, Is.SameAs(prefabPlayerInput.actions));
         Assert.That(player.devices, Is.EquivalentTo(new[] { gamepad }));
         Assert.That(player.currentControlScheme, Is.EqualTo("Gamepad"));
     }
@@ -395,21 +395,6 @@ public void PlayerInput_CanAssignActionsToPlayer()
         Assert.That(playerInput.actions.actionMaps[0].name, Is.EqualTo(actions.actionMaps[0].name));
     }
 
-    [Test]
-    [Category("PlayerInput")]
-    public void PlayerInput_CopiesActionAssetForFirstPlayer()
-    {
-        var go = new GameObject();
-        var playerInput = go.AddComponent<PlayerInput>();
-
-        var actions = InputActionAsset.FromJson(kActions);
-        playerInput.actions = actions;
-
-        Assert.That(playerInput.actions.actionMaps.Count, Is.EqualTo(actions.actionMaps.Count));
-        Assert.That(playerInput.actions.actionMaps[0].name, Is.EqualTo(actions.actionMaps[0].name));
-        Assert.That(playerInput.actions.GetInstanceID(), !Is.EqualTo(actions.GetInstanceID()));
-    }
-
     [Test]
     [Category("PlayerInput")]
     public void PlayerInput_AssigningNewActionsToPlayer_DisablesExistingActions()
@@ -424,12 +409,12 @@ public void PlayerInput_AssigningNewActionsToPlayer_DisablesExistingActions()
         playerInput.actions = actions1;
 
         Assert.That(playerInput.actions.actionMaps[0].enabled, Is.True);
-        Assert.That(actions1.actionMaps[0].enabled, Is.False);
+        Assert.That(actions2.actionMaps[0].enabled, Is.False);
 
         playerInput.actions = actions2;
 
-        Assert.That(actions2.actionMaps[0].enabled, Is.False);
         Assert.That(playerInput.actions.actionMaps[0].enabled, Is.True);
+        Assert.That(actions1.actionMaps[0].enabled, Is.False);
     }
 
     [Test]
@@ -497,6 +482,22 @@ public void PlayerInput_DuplicatingActions_AssignsNewInstanceToUI()
         Assert.That(playerInput2.actions, Is.SameAs(ui2.actionsAsset));
     }
 
+    [Test]
+    [Category("PlayerInput")]
+    public void PlayerInput_ActionFromCodeGeneratedActionIsTheSameBeingReferenced()
+    {
+        var go = new GameObject();
+
+        var playerInput = go.AddComponent<PlayerInput>();
+        var ui = go.AddComponent<InputSystemUIInputModule>();
+        var defaultActions = new DefaultInputActions();
+
+        playerInput.uiInputModule = ui;
+        playerInput.actions = defaultActions.asset;
+
+        Assert.That(defaultActions.UI.Submit == playerInput.actions.FindAction("Submit"), Is.True);
+    }
+
     [Test]
     [Category("PlayerInput")]
     public void PlayerInput_CanPassivateAndReactivateInputBySendingMessages()

Packages/com.unity.inputsystem/InputSystem/InputSystem.cs

@@ -3038,6 +3038,19 @@ private static void EnableActions()
             actions.Enable();
         }
 
+        /// <summary>
+        /// Determines whether project-wide actions are automatically enabled after entering Play Mode.
+        /// </summary>
+        /// <remarks>
+        /// This property is set to <c>true</c> by default.
+        /// </remarks>
+        internal static bool m_EnableActionsAfterEnterPlayMode = true;
+
+        internal static void AllowEnableActionsAfterEnterPlayMode(bool enabled)
+        {
+            m_EnableActionsAfterEnterPlayMode = enabled;
+        }
+
         private static void DisableActions(bool triggerSetupChanged = false)
         {
             // Make sure project wide input actions are disabled
@@ -3408,7 +3421,6 @@ public static int ListEnabledActions(List<InputAction> actions)
 
         #endregion
 
-
         /// <summary>
         /// The current version of the input system package.
         /// </summary>
@@ -3655,7 +3667,7 @@ internal static void OnPlayModeChange(PlayModeStateChange change)
                     // Don't enable actions if some are already enabled.
                     // This is useful when you just want specific action maps to be enabled, but not all
                     // action maps.
-                    if (!InputSystem.actions.enabled)
+                    if (m_EnableActionsAfterEnterPlayMode)
                         EnableActions();
 
 #endif // UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS

Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInput.cs

@@ -954,6 +954,15 @@ public void ActivateInput()
 
             m_InputActive = true;
 
+            // Disable project-wide actions if they are being used by this PlayerInput.
+            #if UNITY_INPUT_SYSTEM_PROJECT_WIDE_ACTIONS
+            if (m_Actions != null && m_Actions == InputSystem.actions)
+            {
+                InputSystem.AllowEnableActionsAfterEnterPlayMode(false);
+                InputSystem.actions.Disable();
+            }
+            #endif
+
             // If we have no current action map but there's a default
             // action map, make it current.
             if (m_CurrentActionMap == null && m_Actions != null && !string.IsNullOrEmpty(m_DefaultActionMap))