Skip to content

Commit cb8cc82

Browse files
committed
updated documentation
1 parent 39e057c commit cb8cc82

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1275,7 +1275,7 @@ public unsafe bool WasPressedThisFrame()
12751275
/// </summary>
12761276
/// <returns>True if the action was pressed in the MonoBehaviour Update cycle (rendering frame).</returns>
12771277
/// <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).
12791279
/// 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"/>.
12801280
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasPressedThisFrame"/>.
12811281
/// </remarks>
@@ -1361,7 +1361,7 @@ public unsafe bool WasReleasedThisFrame()
13611361
/// </summary>
13621362
/// <returns>True if the action was released in the MonoBehaviour Update cycle (rendering frame).</returns>
13631363
/// <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).
13651365
/// 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"/>.
13661366
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasReleasedThisFrame"/>.
13671367
/// </remarks>
@@ -1458,7 +1458,7 @@ public unsafe bool WasPerformedThisFrame()
14581458
/// </summary>
14591459
/// <returns>True if the action performed in the MonoBehaviour Update cycle (rendering frame).</returns>
14601460
/// <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).
14621462
/// 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"/>.
14631463
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasPerformedThisFrame"/>.
14641464
/// </remarks>
@@ -1572,7 +1572,7 @@ public unsafe bool WasCompletedThisFrame()
15721572
/// </summary>
15731573
/// <returns>True if the action completed in this MonoBehaviour Update cycle (rendering frame).</returns>
15741574
/// <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).
15761576
/// 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"/>.
15771577
/// If the update mode is set to <see cref="InputSettings.UpdateMode.ProcessEventsInDynamicUpdate"/>, this method will behave exactly like <see cref="WasCompletedThisFrame"/>.
15781578
/// </remarks>

0 commit comments

Comments
 (0)