Class InputExtensions

Various useful extension methods.

Inheritance
object
InputExtensions
Namespace: UnityEngine.InputSystem
Assembly: Unity.InputSystem.dll
Syntax
public static class InputExtensions

Methods

IsActive(TouchPhase)

Return true if the given phase is Began, Moved, or Stationary, i.e. if a touch with that phase would indicate an ongoing touch.

Declaration
public static bool IsActive(this TouchPhase phase)
Parameters
Type Name Description
TouchPhase phase

A touch phase.
Returns
Type Description
bool

True if the phase indicates a touch that is ongoing.
See Also

IsEndedOrCanceled(TouchPhase)

Return true if the given phase is Canceled or Ended, i.e. if a touch with that phase would no longer be ongoing.

Declaration
public static bool IsEndedOrCanceled(this TouchPhase phase)
Parameters
Type Name Description
TouchPhase phase

A touch phase.
Returns
Type Description
bool

True if the phase indicates a touch that has ended.
See Also

IsInProgress(InputActionPhase)

Return true if the given phase is Started or Performed.

Declaration
public static bool IsInProgress(this InputActionPhase phase)
Parameters
Type Name Description
InputActionPhase phase

An action phase.
Returns
Type Description
bool

True if the phase is started or performed.
See Also

IsModifierKey(Key)

Check if a Key enum value represents a modifier key.

Declaration
public static bool IsModifierKey(this Key key)
Parameters
Type Name Description
Key key

The key enum value you want to check.
Returns
Type Description
bool

true if key represents a modifier key, else false.
Remarks

Modifier keys are any keys you can hold down to modify the output of other keys pressed simultaneously, such as the "shift" or "control" keys.

IsTextInputKey(Key)

Check if a Key enum value represents key generating text input.

Declaration
public static bool IsTextInputKey(this Key key)
Parameters
Type Name Description
Key key

The key enum value you want to check.
Returns
Type Description
bool

true if key represents a key generating non-whitespace text input, else false.