You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Packages/com.unity.inputsystem/InputSystem/Actions/InputAction.cs
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1275,7 +1275,7 @@ public unsafe bool WasPressedThisFrame()
1275
1275
/// </summary>
1276
1276
/// <returns>True if the action was pressed in the MonoBehaviour Update cycle (rendering frame).</returns>
1277
1277
/// <remarks>
1278
-
/// Unlike <see cref="WasPressedThisFrame"/>, this method will return true only if the action was performed in the current dynamic Update cycle.
1278
+
/// Unlike <see cref="WasPressedThisFrame"/>, this method will return true only if the InputSystem was updated and the action was pressed in the current dynamic Update cycle (in between the previous and the current frame).
1279
1279
/// This can be used in dynamic update if the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/>.
1280
1280
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasPressedThisFrame"/>.
1281
1281
/// </remarks>
@@ -1361,7 +1361,7 @@ public unsafe bool WasReleasedThisFrame()
1361
1361
/// </summary>
1362
1362
/// <returns>True if the action was released in the MonoBehaviour Update cycle (rendering frame).</returns>
1363
1363
/// <remarks>
1364
-
/// Unlike <see cref="WasReleasedThisFrame"/>, this method will return true only if the action was performed in the current dynamic Update cycle.
1364
+
/// Unlike <see cref="WasReleasedThisFrame"/>, this method will return true only if the InputSystem was updated and the action was released in the current dynamic Update cycle (in between the previous and the current frame).
1365
1365
/// This can be used in dynamic update if the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/>.
1366
1366
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasReleasedThisFrame"/>.
1367
1367
/// </remarks>
@@ -1458,7 +1458,7 @@ public unsafe bool WasPerformedThisFrame()
1458
1458
/// </summary>
1459
1459
/// <returns>True if the action performed in the MonoBehaviour Update cycle (rendering frame).</returns>
1460
1460
/// <remarks>
1461
-
/// Unlike <see cref="WasPerformedThisFrame"/>, this method will return true only if the action was performed in the current dynamic Update cycle.
1461
+
/// Unlike <see cref="WasPerformedThisFrame"/>, this method will return true only if the InputSystem was updated and the action was performed in the current dynamic Update cycle (in between the previous and the current frame).
1462
1462
/// This can be used in dynamic update if the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/>.
1463
1463
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasPerformedThisFrame"/>.
1464
1464
/// </remarks>
@@ -1572,7 +1572,7 @@ public unsafe bool WasCompletedThisFrame()
1572
1572
/// </summary>
1573
1573
/// <returns>True if the action completed in this MonoBehaviour Update cycle (rendering frame).</returns>
1574
1574
/// <remarks>
1575
-
/// Unlike <see cref="WasCompletedThisFrame"/>, this method will return true only if the action was performed in the current dynamic Update cycle.
1575
+
/// Unlike <see cref="WasCompletedThisFrame"/>, this method will return true only if the InputSystem was updated and the action was completed in the current dynamic Update cycle (in between the previous and the current frame).
1576
1576
/// This can be used in dynamic update if the <see cref="InputSettings.updateMode"/> is set to <see cref="InputSettings.UpdateMode.ProcessEventsInFixedUpdate"/> or <see cref="InputSettings.UpdateMode.ProcessEventsManually"/>.
1577
1577
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasCompletedThisFrame"/>.
0 commit comments