Merge branch 'develop' into docf-1179-fixedupdate-vs-update

Author: duckets

Assets/Samples/InGameHints/InGameHintsActions.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from Assets/Samples/InGameHints/InGameHintsActions.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Assets/Samples/SimpleDemo/SimpleControls.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from Assets/Samples/SimpleDemo/SimpleControls.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Assets/Tests/InputSystem/CoreTests_Analytics.cs

@@ -663,6 +663,55 @@ public void Analytics_ShouldReportPlayerInputManagerData()
         }
     }
 
+    [Test]
+    [Category("Analytics")]
+    public void Analytics_ShouldReportCodeAuthoringAnalytic()
+    {
+        CollectAnalytics(InputExitPlayModeAnalytic.kEventName);
+
+        // NOTE: We do not want to trigger entering/exiting play-mode for this small data-sanity check
+        //       so just stick to triggering it explicitly. A better test would have been an editor test
+        //       going in and out of play-mode for real but not clear if this is really possible.
+
+        // Pretend we are entering play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingEditMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredPlayMode);
+
+        // Assert no data received
+        Assert.That(sentAnalyticsEvents.Count, Is.EqualTo(0));
+
+        // Pretend we are exiting play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingPlayMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredEditMode);
+
+        // Assert: Data received
+        Assert.That(sentAnalyticsEvents.Count, Is.EqualTo(1));
+        Assert.That(sentAnalyticsEvents[0].name, Is.EqualTo(InputExitPlayModeAnalytic.kEventName));
+        Assert.That(sentAnalyticsEvents[0].data, Is.TypeOf<InputExitPlayModeAnalytic.Data>());
+
+        var data0 = (InputExitPlayModeAnalytic.Data)sentAnalyticsEvents[0].data;
+        Assert.That(data0.uses_code_authoring, Is.False);
+
+        // Pretend we are entering play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingEditMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredPlayMode);
+
+        var action = new InputAction("Dance");
+        action.AddBinding("<Keyboard>/Space");
+
+        // Pretend we are exiting play-mode
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.ExitingPlayMode);
+        InputExitPlayModeAnalytic.OnPlayModeStateChange(PlayModeStateChange.EnteredEditMode);
+
+        // Assert: Data received
+        Assert.That(sentAnalyticsEvents.Count, Is.EqualTo(2));
+        Assert.That(sentAnalyticsEvents[1].name, Is.EqualTo(InputExitPlayModeAnalytic.kEventName));
+        Assert.That(sentAnalyticsEvents[1].data, Is.TypeOf<InputExitPlayModeAnalytic.Data>());
+
+        var data1 = (InputExitPlayModeAnalytic.Data)sentAnalyticsEvents[1].data;
+        Assert.That(data1.uses_code_authoring, Is.True);
+    }
+
 #if UNITY_INPUT_SYSTEM_ENABLE_UI
     [Test]
     [Category("Analytics")]

Assets/Tests/InputSystem/InputActionCodeGeneratorActions.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from Assets/Tests/InputSystem/InputActionCodeGeneratorActions.inputactions
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -10,6 +10,8 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased] - yyyy-mm-dd
 
+## [1.11.1] - 2024-09-26
+
 ### Fixed
 - Fixed Multiple interactions could breaks on Composite Binding. [ISXB-619](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-619)
 - Fixed memory leak when the OnScreenStick component was destroyed [ISXB-1070](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-1070). Contribution by [LukeUnityDev](https://github.com/LukeUnityDev).
@@ -45,6 +47,7 @@ however, it has to be formatted properly to pass verification tests.
 - Added tests for Input Action Editor UI for managing action maps (List, create, rename, delete) (ISX-2087)
 - Added automatic loading of custom extensions of InputProcessor, InputInteraction and InputBindingComposite [ISXB-856]](https://issuetracker.unity3d.com/product/unity/issues/guid/ISXB-856).
 - Added an IME Input sample scene.
+- Added analytics for programmatic `InputAction` setup via `InputActionSetupExtensions`.
 
 ## [1.10.0] - 2024-07-24
 

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

@@ -306,6 +306,23 @@ public static BindingSyntax AddBinding(this InputAction action, string path, str
             });
         }
 
+        /// <summary>
+        /// Conditionally compiled helper for logging API usage of code-authored actions.
+        /// </summary>
+        /// <param name="api">The associated API function.</param>
+        /// <remarks>
+        /// Be extremely carefully to review for indirect calls and overloads to not register analytics twice.
+        /// Be extremely careful in enabling/disabling tracking before internal calls since those may otherwise
+        /// be incorrectly registered.
+        /// </remarks>
+        #if UNITY_EDITOR
+        private static void RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api api)
+        {
+            UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Register(api);
+        }
+
+        #endif
+
         /// <summary>
         /// Add a binding that references the given <paramref name="control"/> and triggers
         /// the given <paramref cref="action"/>.
@@ -349,6 +366,10 @@ public static BindingSyntax AddBinding(this InputAction action, InputControl con
         /// </remarks>
         public static BindingSyntax AddBinding(this InputAction action, InputBinding binding = default)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
 
@@ -478,6 +499,10 @@ public static BindingSyntax AddBinding(this InputActionMap actionMap, string pat
         /// <seealso cref="InputActionMap.bindings"/>
         public static BindingSyntax AddBinding(this InputActionMap actionMap, InputBinding binding)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddBinding);
+            #endif
+
             if (actionMap == null)
                 throw new ArgumentNullException(nameof(actionMap));
             if (binding.path == null)
@@ -501,6 +526,10 @@ public static BindingSyntax AddBinding(this InputActionMap actionMap, InputBindi
         public static CompositeSyntax AddCompositeBinding(this InputAction action, string composite,
             string interactions = null, string processors = null)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddCompositeBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
             if (string.IsNullOrEmpty(composite))
@@ -580,6 +609,10 @@ private static int AddBindingInternal(InputActionMap map, InputBinding binding,
         /// of <paramref name="action"/>).</exception>
         public static BindingSyntax ChangeBinding(this InputAction action, int index)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ChangeBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
 
@@ -638,6 +671,10 @@ public static BindingSyntax ChangeBinding(this InputAction action, string name)
         /// of <paramref name="actionMap"/>).</exception>
         public static BindingSyntax ChangeBinding(this InputActionMap actionMap, int index)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ChangeBinding);
+            #endif
+
             if (actionMap == null)
                 throw new ArgumentNullException(nameof(actionMap));
             if (index < 0 || index >= actionMap.m_Bindings.LengthSafe())
@@ -836,6 +873,10 @@ public static BindingSyntax ChangeBinding(this InputAction action, InputBinding
         /// <seealso cref="InputBindingComposite"/>
         public static BindingSyntax ChangeCompositeBinding(this InputAction action, string compositeName)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ChangeCompositeBinding);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
             if (string.IsNullOrEmpty(compositeName))
@@ -877,6 +918,10 @@ public static BindingSyntax ChangeCompositeBinding(this InputAction action, stri
         /// </remarks>
         public static void Rename(this InputAction action, string newName)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.Rename);
+            #endif
+
             if (action == null)
                 throw new ArgumentNullException(nameof(action));
             if (string.IsNullOrEmpty(newName))
@@ -919,6 +964,10 @@ public static void Rename(this InputAction action, string newName)
         /// </remarks>
         public static void AddControlScheme(this InputActionAsset asset, InputControlScheme controlScheme)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.AddControlScheme);
+            #endif
+
             if (asset == null)
                 throw new ArgumentNullException(nameof(asset));
             if (string.IsNullOrEmpty(controlScheme.name))
@@ -987,6 +1036,10 @@ public static ControlSchemeSyntax AddControlScheme(this InputActionAsset asset,
         /// </remarks>
         public static void RemoveControlScheme(this InputActionAsset asset, string name)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.RemoveControlScheme);
+            #endif
+
             if (asset == null)
                 throw new ArgumentNullException(nameof(asset));
             if (string.IsNullOrEmpty(name))
@@ -1007,33 +1060,57 @@ public static void RemoveControlScheme(this InputActionAsset asset, string name)
         /// <returns><paramref name="scheme"/></returns>
         public static InputControlScheme WithBindingGroup(this InputControlScheme scheme, string bindingGroup)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithBindingGroup);
+            #endif
+
             return new ControlSchemeSyntax(scheme).WithBindingGroup(bindingGroup).Done();
         }
 
         public static InputControlScheme WithDevice(this InputControlScheme scheme, string controlPath, bool required)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithDevice);
+            #endif
+
             if (required)
                 return new ControlSchemeSyntax(scheme).WithRequiredDevice(controlPath).Done();
             return new ControlSchemeSyntax(scheme).WithOptionalDevice(controlPath).Done();
         }
 
         public static InputControlScheme WithRequiredDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithRequiredDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).WithRequiredDevice(controlPath).Done();
         }
 
         public static InputControlScheme WithOptionalDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeWithOptionalDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).WithOptionalDevice(controlPath).Done();
         }
 
         public static InputControlScheme OrWithRequiredDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeOrWithRequiredDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).OrWithRequiredDevice(controlPath).Done();
         }
 
         public static InputControlScheme OrWithOptionalDevice(this InputControlScheme scheme, string controlPath)
         {
+            #if UNITY_EDITOR
+            RegisterApiUsage(UnityEngine.InputSystem.Editor.InputExitPlayModeAnalytic.Api.ControlSchemeOrWithOptionalDevice);
+            #endif
+
             return new ControlSchemeSyntax(scheme).OrWithOptionalDevice(controlPath).Done();
         }
 

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

@@ -123,8 +123,8 @@ public bool ControlIsActuated(float threshold = 0)
         /// Mark the interaction has having begun.
         /// </summary>
         /// <remarks>
-        /// Note that this affects the current interaction only. There may be multiple interactions on a binding
-        /// and arbitrary many interactions may concurrently be in started state. However, only one interaction
+        /// This affects the current interaction only. There might be multiple interactions on a binding
+        /// and arbitrary many interactions might concurrently be in started state. However, only one interaction
         /// (usually the one that starts first) is allowed to drive the action's state as a whole. If an interaction
         /// that is currently driving an action is canceled, however, the next interaction in the list that has
         /// been started will take over and continue driving the action.
@@ -161,13 +161,31 @@ public void Started()
             m_State.ChangePhaseOfInteraction(InputActionPhase.Started, ref m_TriggerState);
         }
 
+        /// <summary>
+        /// Marks the interaction as being performed and then transitions back to <see cref="InputActionPhase.Waiting"/>
+        /// to wait for input. This behavior is desirable for interaction events that are instant and reflect
+        /// a transitional interaction pattern such as <see cref="Interactions.PressInteraction"/> or <see cref="Interactions.TapInteraction"/>.
+        /// </summary>
+        /// <remarks>
+        /// Note that this affects the current interaction only. There might be multiple interactions on a binding
+        /// and arbitrary many interactions might concurrently be in started state. However, only one interaction
+        /// (usually the one that starts first) is allowed to drive the action's state as a whole. If an interaction
+        /// that is currently driving an action is canceled, however, the next interaction in the list that has
+        /// been started will take over and continue driving the action.
+        /// </remarks>
         public void Performed()
         {
             if (m_TriggerState.phase == InputActionPhase.Waiting)
                 m_TriggerState.startTime = time;
             m_State.ChangePhaseOfInteraction(InputActionPhase.Performed, ref m_TriggerState);
         }
 
+        /// <summary>
+        /// Marks the interaction as being performed and then transitions into I <see cref="InputActionPhase.Started"/>
+        /// to wait for an initial trigger condition to be true before being performed again. This behavior
+        /// may be desirable for interaction events that reflect transitional interaction patterns but should
+        /// be considered as started until a cancellation condition is true, such as releasing a button.
+        /// </summary>
         public void PerformedAndStayStarted()
         {
             if (m_TriggerState.phase == InputActionPhase.Waiting)
@@ -176,6 +194,12 @@ public void PerformedAndStayStarted()
                 phaseAfterPerformed: InputActionPhase.Started);
         }
 
+        /// <summary>
+        /// Marks the interaction as being performed and then stays in that state waiting for an input to
+        /// cancel the interactions active state. This behavior is desirable for interaction events that
+        /// are active for a duration until a cancellation condition is true, such as <see cref="Interactions.HoldInteraction"/> or <see cref="Interactions.TapInteraction"/> where releasing
+        /// the associated button cancels the interaction..
+        /// </summary>
         public void PerformedAndStayPerformed()
         {
             if (m_TriggerState.phase == InputActionPhase.Waiting)
@@ -184,6 +208,16 @@ public void PerformedAndStayPerformed()
                 phaseAfterPerformed: InputActionPhase.Performed);
         }
 
+        /// <summary>
+        ///  Marks the interaction as being interrupted or aborted. This is relevant to signal that the interaction
+        ///  pattern was not completed, for example, the user pressed and then released a button before the minimum
+        ///  time required for a <see cref="Interactions.HoldInteraction"/> to complete.
+        /// </summary>
+        /// <remarks>
+        /// This is used by most existing interactions to cancel the transitions in the interaction state machine
+        /// when a condition required to proceed turned false or other indirect requirements were not met, such as
+        /// time-based conditions.
+        /// </remarks>
         public void Canceled()
         {
             if (m_TriggerState.phase != InputActionPhase.Canceled)

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

@@ -16,7 +16,7 @@ public static partial class InputSystem
         // Keep this in sync with "Packages/com.unity.inputsystem/package.json".
         // NOTE: Unfortunately, System.Version doesn't use semantic versioning so we can't include
         //       "-preview" suffixes here.
-        internal const string kAssemblyVersion = "1.11.1";
+        internal const string kAssemblyVersion = "1.11.2";
         internal const string kDocUrl = "https://docs.unity3d.com/Packages/[email protected]";
     }
 }

Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastKeyboard.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputLayoutCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from "Keyboard" layout
 //
 //     Changes to this file may cause incorrect behavior and will be lost if

Packages/com.unity.inputsystem/InputSystem/Devices/Precompiled/FastMouse.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputLayoutCodeGenerator
-//     version 1.11.1
+//     version 1.11.2
 //     from "Mouse" layout
 //
 //     Changes to this file may cause incorrect behavior and will be lost if