The **UserInputState** enum describes the state of an input that is currently
or was recently performed. It is used by the
`Class.InputObject.UserInputState` property of the same name, as well as
various `Class.UserInputService` and `Class.GuiObject` events.

Depending on the `Enum.UserInputType`, input may follow states differently.

- Simple button and key presses generally follow a simple **Begin** &rarr;
  **End** flow.
  - Gamepad trigger buttons are similar to button presses, but will use
    **Change** as the state of the button changes.
- Mouse movement generally follows **Begin** (mouse-over) &rarr; **Change**
  &rarr; **End** (mouse-leave).
  - Touch input behaves somewhat similarly to mouse movement. **Begin** and
    **End** occur when the user starts or ends touching the screen,
    respectively. The same `Class.InputObject` is used for the same touch
    point.
- Gamepad thumbstick controls will cause **Change** to occur each frame the
  position changes.

## Cancel

In the context of `Class.ContextActionService`, binding action-handling
functions using `Class.ContextActionService:BindAction()|BindAction` provides
a UserInputState to the action handler when a relevant input is performed. If
an in-progress input associated with a bound action is then
`Class.ContextActionService:UnbindAction()|unbound` or becomes relevant to a
different input, the **Cancel** UserInputState is passed, indicating that the
input is no longer relevant to the action.


Begin

Occurs when an `Class.InputObject` starts to interact with the game. For
example, a mouse button down, or a key down, or when a touch begins
touching the screen.


Change

Occurs each frame an `Class.InputObject` has already begun interacting
with the game and part of its state is changing. For example, a movement
of the mouse position, a gamepad thumbstick, gamepad trigger button, or
screen touch point.


When an `Class.InputObject` finishes interacting with the game. For
example, a mouse button up, or a key up, or when a touch stops touching
the screen.


Cancel

A special circumstance state that indicates this input is no longer
relevant, particularly with `Class.ContextActionService`. For example,
binding two action-handling functions will cause the first to Cancel if an
input was already in-progress when the second was bound.


None

A state that should never be seen in a game, essentially just marks the
end of the enum.


UserInputState

The **UserInputState** enum describes the state of an input that is currently
or was recently performed.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

Name	Value	Summary
Begin	0
Change	1
End	2
Cancel	3
None	4

UserInputState

Items