NEW: Added support for F13 to F24 keys (#2075)

Co-authored-by: Stefan Schubert <stefan@unity3d.com>

Author: bmalrat

Assets/Samples/InGameHints/InGameHintsActions.cs

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

Assets/Tests/InputSystem/APIVerificationTests.cs

@@ -554,6 +554,10 @@ public class DualShock4GamepadHID : DualShockGamepad
         public int right = 0;
         public int up = 0;
     ")]
+    // KeyboardState state size has increased to support more keys like F13-F24
+    [ScopedExclusionProperty("1.0.0", "UnityEngine.InputSystem.LowLevel", "public struct KeyboardState : IInputStateTypeInfo", "public fixed byte keys[14];")]
+    // Allow Key.IMESelected to be marked as Obsolete
+    [ScopedExclusionProperty("1.0.0", "UnityEngine.InputSystem", "public enum Key", "IMESelected = 111,")]
     public void API_MinorVersionsHaveNoBreakingChanges()
     {
         var currentVersion = CoreTests.PackageJson.ReadVersion();

Assets/Tests/InputSystem/CorePerformanceTests.cs

@@ -123,8 +123,13 @@ public void Performance_ReadEveryKey()
 
         Measure.Method(() =>
         {
+            int keyIndex = 0;
             foreach (var key in keyboard.allKeys)
+            {
+                if (++keyIndex == (int)KeyEx.IMESelected)  // Skip IMESelected as it's not a real key.
+                    continue;
                 key.ReadValue();
+            }
         })
             .MeasurementCount(100)
             .WarmupCount(5)

Assets/Tests/InputSystem/CoreTests_Devices.cs

@@ -2674,10 +2674,59 @@ public void Devices_AnyKeyOnKeyboard_DoesNotReactToIMESelected()
     {
         var keyboard = InputSystem.AddDevice<Keyboard>();
 
-        InputSystem.QueueStateEvent(keyboard, new KeyboardState(Key.IMESelected));
+        InputSystem.QueueStateEvent(keyboard, new KeyboardState(IMESelected: true));
         InputSystem.Update();
 
         Assert.That(keyboard.anyKey.isPressed, Is.False);
+        Assert.That(keyboard.imeSelected.isPressed, Is.True);
+    }
+
+    [Test]
+    [Category("Devices")]
+    [Obsolete("Test obsolete IMESelected Key")]
+    public void Devices_ImeSelectedKeyOnKeyboard_SupportObsoleteIMESelectedKey()
+    {
+        var keyboard = InputSystem.AddDevice<Keyboard>();
+
+        InputSystem.QueueStateEvent(keyboard, new KeyboardState(Key.IMESelected));
+        InputSystem.Update();
+
+        Assert.That(keyboard.imeSelected.isPressed, Is.True);
+    }
+
+    [Test]
+    [Category("Devices")]
+    public void Devices_ImeSelectedKeyOnKeyboard_IsBackwardCompatible()
+    {
+        var keyboard = InputSystem.AddDevice<Keyboard>();
+
+        var oldKeyboardStateWithIMESelected = new KeyboardState(Key.None);
+        // Hard coded state from previous version that have IMESelected setted
+        unsafe
+        {
+            oldKeyboardStateWithIMESelected.keys[0] = 0;
+            oldKeyboardStateWithIMESelected.keys[1] = 0;
+            oldKeyboardStateWithIMESelected.keys[2] = 0;
+            oldKeyboardStateWithIMESelected.keys[3] = 0;
+            oldKeyboardStateWithIMESelected.keys[4] = 0;
+            oldKeyboardStateWithIMESelected.keys[5] = 0;
+            oldKeyboardStateWithIMESelected.keys[6] = 0;
+            oldKeyboardStateWithIMESelected.keys[7] = 0;
+
+            oldKeyboardStateWithIMESelected.keys[8] = 0;
+            oldKeyboardStateWithIMESelected.keys[9] = 0;
+            oldKeyboardStateWithIMESelected.keys[10] = 0;
+            oldKeyboardStateWithIMESelected.keys[11] = 0;
+            oldKeyboardStateWithIMESelected.keys[12] = 0;
+            oldKeyboardStateWithIMESelected.keys[13] = 128;
+            oldKeyboardStateWithIMESelected.keys[14] = 0;
+            oldKeyboardStateWithIMESelected.keys[15] = 0;
+        }
+
+        InputSystem.QueueStateEvent(keyboard, oldKeyboardStateWithIMESelected);
+        InputSystem.Update();
+
+        Assert.That(keyboard.imeSelected.isPressed, Is.True);
     }
 
     [Test]

Assets/Tests/InputSystem/InputActionCodeGeneratorActions.cs

@@ -1,7 +1,7 @@
 //------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was auto-generated by com.unity.inputsystem:InputActionCodeGenerator
-//     version 1.13.2
+//     version 1.14.0
 //     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,12 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased] - yyyy-mm-dd
 
+### Changed
+- Changed enum value `Key.IMESelected` to obsolete which was not a real key. Please use the ButtonControl `imeSelected`.
+
+### Added
+- Added support of F13-F24 keys. [UUM-44328](https://issuetracker.unity3d.com/product/unity/issues/guid/UUM-44328)
+
 ## [1.13.1] - 2025-02-18
 
 ### Fixed

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.13.2";
-        internal const string kDocUrl = "https://docs.unity3d.com/Packages/com.unity.inputsystem@1.13";
+        internal const string kAssemblyVersion = "1.14.0";
+        internal const string kDocUrl = "https://docs.unity3d.com/Packages/com.unity.inputsystem@1.14";
     }
 }