Skip to content

Commit 1eebb72

Browse files
authored
Fixed some doc wording
1 parent e02fd35 commit 1eebb72

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1792,27 +1792,27 @@ internal int BindingIndexOnMapToBindingIndexOnAction(int indexOfBindingOnMap)
17921792
/// </summary>
17931793
/// <remarks>
17941794
/// The callback context represents the current state of an <see cref="action"/> associated with the callback
1795-
/// and provides information associated with the bound <see cref="control"/>, its value as well as its
1795+
/// and provides information associated with the bound <see cref="control"/>, its value, and its
17961796
/// <see cref="phase"/>.
17971797
///
1798-
/// The callback context provides means to consume events (push-based input) as part of an update when using
1799-
/// input action callback notifications, e.g. <see cref="InputAction.started"/>,
1798+
/// The callback context provides you with a way to consume events (push-based input) as part of an update when using
1799+
/// input action callback notifications. For example, <see cref="InputAction.started"/>,
18001800
/// <see cref="InputAction.performed"/>, <see cref="InputAction.canceled"/> rather than relying on
18011801
/// pull-based reading.
18021802
///
18031803
/// Use this struct to read the current input value through any of the read-method overloads:
18041804
/// <see cref="ReadValue{T}()"/>, <see cref="ReadValueAsButton"/>,
1805-
/// <see cref="ReadValueAsObject()"/> or <see cref="ReadValue" /> (unsafe). If the expected value type is not
1806-
/// known, it maye be required to check <see cref="valueType"/> before reading the value.
1805+
/// <see cref="ReadValueAsObject()"/> or <see cref="ReadValue" /> (unsafe). If you don't know the expected value type,
1806+
/// you might need to check <see cref="valueType"/> before reading the value.
18071807
///
18081808
/// Use the <see cref="phase"/> property to get the current phase of the associated action or
1809-
/// evaluate it directly via any of the convenience methods <see cref="started"/>, <see cref="performed"/>,
1809+
/// evaluate it directly using any of the convenience methods <see cref="started"/>, <see cref="performed"/>,
18101810
/// <see cref="canceled"/>.
18111811
///
1812-
/// To obtain information about the current timestamp of the associated event or reason about for how
1813-
/// long the action have been performing use <see cref="time"/> or <see cref="startTime"/> respectively.
1812+
/// To obtain information about the current timestamp of the associated event, or to check when the event
1813+
/// started, use <see cref="time"/> or <see cref="startTime"/> respectively.
18141814
///
1815-
/// This struct should not be held on to past the duration of the callback.
1815+
/// You should not use or keep this struct outside of the callback.
18161816
///
18171817
/// <example>
18181818
/// <code>

0 commit comments

Comments
 (0)