From 5779dbc1a3fa5502738551a2bd9c88d0986c745b Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 13:54:51 -0400 Subject: [PATCH 1/9] DOCATT-8557: Removed sentence with QuerySamplingFrequencyCommand link --- Packages/com.unity.inputsystem/InputSystem/Devices/Sensor.cs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Devices/Sensor.cs b/Packages/com.unity.inputsystem/InputSystem/Devices/Sensor.cs index 413d76f92d..674ed4dda9 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Devices/Sensor.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Devices/Sensor.cs @@ -100,8 +100,7 @@ public class Sensor : InputDevice /// Note that when setting sampling frequencies, there may be limits on the range of frequencies /// supported by the underlying hardware/platform. /// - /// To support querying sampling frequencies, a sensor device must implement . - /// To support setting frequencies, it must implemenet . + /// To support setting frequencies, it must implement . /// /// Thrown when reading the property and the underlying /// sensor does not support querying of sampling frequencies. From 3f2f39498effdcac3d09c9d5f6fc4238f8046390 Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 14:22:30 -0400 Subject: [PATCH 2/9] DOCATT-8558: Updated RebindingOperation example with local variable in OnClick() --- .../InputSystem/Actions/InputActionRebindingExtensions.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Actions/InputActionRebindingExtensions.cs b/Packages/com.unity.inputsystem/InputSystem/Actions/InputActionRebindingExtensions.cs index 0ff8a5754e..d040797a8f 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Actions/InputActionRebindingExtensions.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Actions/InputActionRebindingExtensions.cs @@ -1326,8 +1326,8 @@ private static void LoadBindingOverridesFromJsonInternal(this IInputActionCollec /// /// public void OnClick() /// { - /// var rebind = actionReference.action.PerformInteractiveRebinding().WithTargetBinding(bindingIndex).OnComplete(_ => UpdateDisplayText()); - /// rebind.Start(); + /// var l_rebind = actionReference.action.PerformInteractiveRebinding().WithTargetBinding(bindingIndex).OnComplete(_ => UpdateDisplayText()); + /// l_rebind.Start(); /// } /// /// private void UpdateDisplayText() From 130013bf8878b5bb0b9fd94f4698b337e4f50037 Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 14:56:23 -0400 Subject: [PATCH 3/9] DOCATT-8610: Updated PlayerInputManager.cs and PlayerJoinBehavior.cs - Added doc for JoinPlayersWhenJoinActionIsTriggered value - Clarified that disabling the action can result when DisableJoining() is called on an action that was joined with the JoinPlayersWhenJoinActionIsTriggered behaviour --- .../Plugins/PlayerInput/PlayerInputManager.cs | 6 ++++++ .../Plugins/PlayerInput/PlayerJoinBehavior.cs | 10 ++++++++-- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs index 2c2c557766..77368112cc 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs @@ -334,6 +334,12 @@ public void EnableJoining() /// /// Inhibit players from joining the game. /// + /// + /// Note that this method might disable the action, depending on how the action + /// was joined initially. Specifically, if the initial joining was triggered using + /// the behavior, + /// this method also disables the join action. + /// /// /// public void DisableJoining() diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs index baa0181efe..5e412f0eee 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs @@ -15,11 +15,17 @@ public enum PlayerJoinBehavior /// JoinPlayersWhenButtonIsPressed, + /// + /// Listen for button presses on devices that are not paired to any player. If the control + /// they triggered matches a specific action and joining is allowed, join a new player using + /// the device the button was pressed on. + /// JoinPlayersWhenJoinActionIsTriggered, /// - /// Do not join players automatically. Call or - /// explicitly in order to join new players. Alternatively, just create GameObjects with + /// Don't join players automatically. Call + /// or explicitly in order to join new + /// players. Alternatively, just create GameObjects with /// components directly and they will be joined automatically. /// /// From 0cc9d1c90697a869a07874a0d011299f49ed4243 Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 15:07:18 -0400 Subject: [PATCH 4/9] DOCATT-8611: Filter out the docs for internal platformUserAccountXXX --- Packages/com.unity.inputsystem/Documentation~/filter.yml | 9 ++++++++- .../InputSystem/Plugins/Users/InputUser.cs | 3 +++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/Packages/com.unity.inputsystem/Documentation~/filter.yml b/Packages/com.unity.inputsystem/Documentation~/filter.yml index ec90ba2c34..2746e1ba86 100644 --- a/Packages/com.unity.inputsystem/Documentation~/filter.yml +++ b/Packages/com.unity.inputsystem/Documentation~/filter.yml @@ -87,4 +87,11 @@ apiRules: type: Type - exclude: uidRegex: ^UnityEngine\.InputSystem\.XR\.EyesControl$ - type: Type \ No newline at end of file + type: Type + - exclude: + uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.platformAccount.*$ + type: Member + - exclude: + uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.FindUserByAccount$ + type: Method + diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs index 02518240b7..f2745d9d19 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs @@ -102,6 +102,7 @@ public int index public uint id => m_Id; ////TODO: bring documentation for these back when user management is implemented on Xbox and PS + ////For now the docs are filtered out (see Documentation~/filter.yml) public InputUserAccountHandle? platformUserAccountHandle => s_GlobalState.allUserData[index].platformUserAccountHandle; public string platformUserAccountName => s_GlobalState.allUserData[index].platformUserAccountName; public string platformUserAccountId => s_GlobalState.allUserData[index].platformUserAccountId; @@ -767,6 +768,8 @@ public static int GetUnpairedInputDevices(ref InputControlList list return s_GlobalState.allUsers[userIndex]; } + + ////Doc is filtered out (see Documentation~/filter.yml) public static InputUser? FindUserByAccount(InputUserAccountHandle platformUserAccountHandle) { if (platformUserAccountHandle == default(InputUserAccountHandle)) From 2a4a22f281fe4da7ba5b06f8ec751132b67603ca Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 15:18:29 -0400 Subject: [PATCH 5/9] DOCATT-8541: Added clarification to InputInteractionContext.SetTimeout --- .../InputSystem/Actions/InputInteractionContext.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Actions/InputInteractionContext.cs b/Packages/com.unity.inputsystem/InputSystem/Actions/InputInteractionContext.cs index 16df3c68c0..6e9461f335 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Actions/InputInteractionContext.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Actions/InputInteractionContext.cs @@ -250,7 +250,7 @@ public void Waiting() /// being true. /// /// Changing the phase of the interaction while a timeout is running will implicitly cancel - /// the timeout. + /// the timeout. For example, you must call before calling `SetTimeout()`. /// /// /// From 638e3df384bf8e90656a10be215a055e7c9124b0 Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 17:22:17 -0400 Subject: [PATCH 6/9] DOCATT-8611: Tweaked the filter for InputUser accounts --- Packages/com.unity.inputsystem/Documentation~/filter.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Packages/com.unity.inputsystem/Documentation~/filter.yml b/Packages/com.unity.inputsystem/Documentation~/filter.yml index 2746e1ba86..f7093e9c2a 100644 --- a/Packages/com.unity.inputsystem/Documentation~/filter.yml +++ b/Packages/com.unity.inputsystem/Documentation~/filter.yml @@ -89,9 +89,9 @@ apiRules: uidRegex: ^UnityEngine\.InputSystem\.XR\.EyesControl$ type: Type - exclude: - uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.platformAccount.*$ + uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.platformUserAccount.*$ type: Member - exclude: - uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.FindUserByAccount$ + uidRegex: ^UnityEngine\.InputSystem\.Users\.InputUser\.FindUserByAccount.*$ type: Method From 0197b65ca56a1167aad57386565f723490694052 Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 17:29:24 -0400 Subject: [PATCH 7/9] DOCATT-8610: Fixed the link to JoinPlayersWhenJoinActionIsTriggered --- .../InputSystem/Plugins/PlayerInput/PlayerInputManager.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs index 77368112cc..b66d75e88e 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs @@ -337,7 +337,7 @@ public void EnableJoining() /// /// Note that this method might disable the action, depending on how the action /// was joined initially. Specifically, if the initial joining was triggered using - /// the behavior, + /// the behavior, /// this method also disables the join action. /// /// From 9ecbd98cbab05040790bacb7232bd43666f10136 Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Thu, 18 Sep 2025 17:44:07 -0400 Subject: [PATCH 8/9] Reformatted code --- .../InputSystem/Plugins/PlayerInput/PlayerInputManager.cs | 4 ++-- .../InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs | 8 ++++---- .../InputSystem/Plugins/Users/InputUser.cs | 1 - 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs index b66d75e88e..5d4cd70d8f 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs @@ -335,9 +335,9 @@ public void EnableJoining() /// Inhibit players from joining the game. /// /// - /// Note that this method might disable the action, depending on how the action + /// Note that this method might disable the action, depending on how the action /// was joined initially. Specifically, if the initial joining was triggered using - /// the behavior, + /// the behavior, /// this method also disables the join action. /// /// diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs index 5e412f0eee..c9d2cf49fd 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerJoinBehavior.cs @@ -16,15 +16,15 @@ public enum PlayerJoinBehavior JoinPlayersWhenButtonIsPressed, /// - /// Listen for button presses on devices that are not paired to any player. If the control - /// they triggered matches a specific action and joining is allowed, join a new player using + /// Listen for button presses on devices that are not paired to any player. If the control + /// they triggered matches a specific action and joining is allowed, join a new player using /// the device the button was pressed on. /// JoinPlayersWhenJoinActionIsTriggered, /// - /// Don't join players automatically. Call - /// or explicitly in order to join new + /// Don't join players automatically. Call + /// or explicitly in order to join new /// players. Alternatively, just create GameObjects with /// components directly and they will be joined automatically. /// diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs index f2745d9d19..6dc3705c90 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/Users/InputUser.cs @@ -768,7 +768,6 @@ public static int GetUnpairedInputDevices(ref InputControlList list return s_GlobalState.allUsers[userIndex]; } - ////Doc is filtered out (see Documentation~/filter.yml) public static InputUser? FindUserByAccount(InputUserAccountHandle platformUserAccountHandle) { From 70c1839251ea8d040c01926a7a1a9376670bf8ab Mon Sep 17 00:00:00 2001 From: Amy Louise Green Date: Fri, 19 Sep 2025 12:17:03 -0400 Subject: [PATCH 9/9] DOCATT-8610: Fixed bad wording for joining the action in PlayerInputManager.cs --- .../InputSystem/Plugins/PlayerInput/PlayerInputManager.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs index 5d4cd70d8f..fde6eae7bb 100644 --- a/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs +++ b/Packages/com.unity.inputsystem/InputSystem/Plugins/PlayerInput/PlayerInputManager.cs @@ -335,8 +335,8 @@ public void EnableJoining() /// Inhibit players from joining the game. /// /// - /// Note that this method might disable the action, depending on how the action - /// was joined initially. Specifically, if the initial joining was triggered using + /// Note that this method might disable the action, depending on how the player + /// joined initially. Specifically, if the initial joining was triggered using /// the behavior, /// this method also disables the join action. ///