`Class.VirtualInput` simulates mouse, keyboard, and pointer input as if it
were performed by a real player. It is intended for **testing purposes only**
and can only be obtained by calling
`Class.UserInputService:CreateVirtualInput()`.

All input methods throw a runtime error if the simulated input would interact
with Roblox's built-in UI (`Class.CoreGui`), such as the top bar, chat window,
or escape menu. This prevents automation tests from accidentally interfering
with system UI that players depend on.


This method injects a keyboard key press or release event, processed
identically to a real hardware key event.

This method throws a runtime error if `Class.CoreGui` has keyboard focus,
which includes a `Class.TextBox` inside `Class.CoreGui` being focused, a
`Class.CoreGui` element selected for keyboard or gamepad navigation, or
the in-game escape menu being open. It also throws if the requested key is
permanently bound to a Roblox core action (for example, the
<kbd>Escape</kbd> key).

#### isRepeatedKey

Set `isRepeatedKey` to `true` only when simulating the OS auto-repeat
behavior that occurs while a player physically holds a key down which
fires a stream of repeated events after the initial key press. This is
meaningful only for text-manipulation keys: `Enum.KeyCode.Backspace`,
`Enum.KeyCode.Delete`, and the arrow keys (`Enum.KeyCode.Left`,
`Enum.KeyCode.Right`, `Enum.KeyCode.Up`, and `Enum.KeyCode.Down`). Passing
`true` for any other key throws a runtime error.

For example, to simulate holding <kbd>Backspace</kbd> to delete multiple
characters, call:

- `SendKey(true, Enum.KeyCode.Backspace, false)` for the initial press
- `SendKey(true, Enum.KeyCode.Backspace, true)` in a loop for each
  repeated event
- `SendKey(false, Enum.KeyCode.Backspace, false)` for the release

Do **not** pass `isRepeatedKey` as `true` for the initial press or the
release. For any key that does not involve text editing (game action keys,
modifier keys, function keys, etc.), always pass `false`.


VirtualInput:SendKey

isPressed

Whether to simulate a key press (`true`) or a key release (`false`).


keyCode

The `Enum.KeyCode` of the key to inject.


isRepeatedKey

Whether this is an auto-repeat event, as occurs when a key is held
down. Only valid for text-manipulation keys such as
`Enum.KeyCode.Backspace`, `Enum.KeyCode.Delete`, and the arrow keys.
Defaults to `false`.


Injects a keyboard key press or release event.


This method injects a mouse button press or release event at the given
screen-space position, processed identically to a real hardware mouse
event.

Only `Enum.UserInputType.MouseButton1`, `Enum.UserInputType.MouseButton2`,
and `Enum.UserInputType.MouseButton3` are supported; passing any other
value throws a runtime error.

This method throws a runtime error if the specified position overlaps an
interactive `Class.CoreGui` element such as a button or an active overlay
in the top bar, chat window, or escape menu. It also throws if the
specified button is already in the requested state, for example pressing a
button that is already pressed.


VirtualInput:SendMouseButton

position

The screen-space position in pixels at which to inject the event.


button

The mouse button to use. Supported values are
`Enum.UserInputType.MouseButton1`, `Enum.UserInputType.MouseButton2`,
and `Enum.UserInputType.MouseButton3`.


isDown

Whether to simulate a button press (`true`) or a button release
(`false`).


repeatCount

The consecutive-click count for multi-click detection, such as a
double- or triple-click. Defaults to `0`.


Injects a mouse button press or release event at the specified screen
position.


This method injects a relative mouse movement event, representing how far
the mouse moved rather than where it is on screen. This is intended for
use while the player's cursor is locked, such as in first-person camera
mode.

This method throws a runtime error when the cursor is not locked. To move
the cursor to an absolute screen position instead, use
`Class.VirtualInput:SendMousePosition()|SendMousePosition()`.


VirtualInput:SendMouseDelta

positionDelta

The relative mouse movement in pixels along each axis.


Injects a relative mouse movement event. Only works while the player's
cursor is locked.


This method moves the virtual mouse cursor to the specified absolute
screen-space position, processed identically to a real hardware mouse-move
event.

This method throws a runtime error when the specified position overlaps an
interactive Roblox UI element (such as a button or active overlay in the
top bar, chat window, or escape menu).

To inject relative mouse movement while the cursor is locked, use
`Class.VirtualInput:SendMouseDelta()|SendMouseDelta()` instead.


VirtualInput:SendMousePosition

The target screen-space position in pixels.


Moves the virtual mouse cursor to the specified absolute screen position.


This method injects a pointer action event at the given screen-space
position. The `pointerAction` dictionary accepts the following keys:

- `Wheel` (number) — Scroll wheel delta. Positive values scroll forward,
  negative values scroll backward.
- `Pan` (`Datatype.Vector2`) — Trackpad pan delta in pixels.
- `Pinch` (number) — Pinch-to-zoom delta. Positive values zoom in,
  negative values zoom out.

This method throws a runtime error if the specified position overlaps an
interactive Roblox UI element (such as a button or active overlay in the
top bar, chat window, or escape menu). If all values in `pointerAction`
are zero, the call returns without injecting any event.


VirtualInput:SendPointerAction

pointerAction

A dictionary describing the pointer action to inject. Accepted keys
are `Wheel` (number), `Pan` (`Datatype.Vector2`), and `Pinch`
(number). At least one key must have a non-zero value.


Injects a scroll wheel, trackpad pan, or pinch gesture event at the
specified screen position.


This method injects a text input event, routing the given string directly
to the focused `Class.TextBox` or the experience's text input handler as
if the player typed it on a physical keyboard. This is useful for
populating text fields without needing to simulate individual key presses.

This method throws a runtime error if `Class.CoreGui` has keyboard focus,
which includes a `Class.TextBox` inside `Class.CoreGui` being focused, a
`Class.CoreGui` element selected for keyboard or gamepad navigation, or
the in-game escape menu being open.


VirtualInput:SendTextInput

text

Injects a text input event as if the specified string was typed on a
keyboard.


VirtualInput

Simulates mouse, keyboard, and pointer input as if it were performed by a real
player.


`Object` is the base class for all classes in the Roblox class hierarchy.
Every other class that the Roblox Engine defines inherits all of the members
of `Object`. It is not possible to directly create an `Object`.


This sample demonstrates the subtleties of the `Changed` event on normal
objects and `Value` objects.


This code sample demonstrates the Changed event firing within a parent object.


This event fires immediately after an object property is changed, with
some exceptions (see below). The new value of a changed property is
**not** passed as a parameter. Instead, you can access it using
`object[property]`:

```
object.Changed:Connect(function(property)
	print("The new property's value is", object[property])
end)
```

- If you are only interested in listening for changes to one specific
  property, consider using the
  `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`
  method instead.
- To listen for changes in attributes, see
  `Class.Instance:GetAttributeChangedSignal()` and
  `Class.Instance.AttributeChanged`.
- To detect when children are added or removed, see
  `Class.Instance.ChildAdded` and `Class.Instance.ChildRemoved`.

For `Class.ValueBase` objects such as `Class.IntValue` and
`Class.StringValue`, this event only fires when the object's `Value`
property changes. To detect other changes in `Class.ValueBase` objects,
use `Class.Object:GetPropertyChangedSignal()|GetPropertyChangedSignal()`.

#### Limitations

This event does **not** fire for physics-related changes, such as when the
`Class.BasePart.CFrame|CFrame`,
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`,
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`,
`Class.BasePart.Position|Position`, or
`Class.BasePart.Orientation|Orientation` properties of a `Class.BasePart`
change due to gravity. To detect changes in these properties, consider
using a physics-based event like `Class.RunService.PreSimulation`.
Similarly, the `Changed` event does not fire when
`Class.BasePart.AssemblyMass|AssemblyMass` updates due to a change in
material, size, or density for a welded part (but the event does fire for
`Class.BasePart.Mass|Mass` if you modify a part's size).

For properties that change frequently, the `Changed` event might not fire
for every modification, or it might not fire at all. **If a property
change impacts your game logic, test carefully** to ensure the event is
firing as you expect.


Object.Changed

property

Fires immediately after a property of the object changes, with some
limitations.


This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


This method returns an event that behaves exactly like the
`Class.Object.Changed|Changed` event, except that it only fires when the
given property changes. It's generally a good idea to use this method
instead of a connection to `Class.Object.Changed|Changed` with a function
that checks the property name. Subsequent calls to this method on the same
object with the same property name return the same event.

`Class.ValueBase` objects, such as `Class.IntValue` and
`Class.StringValue`, use a modified `Class.Object.Changed|Changed` event
that fires with the contents of their `Value` property. As such, this
method provides a way to detect changes in other properties of those
objects.

Note that this event will not pass any arguments to a connected function,
so the value of the changed property must be read directly within a
script.

#### Limitations

The event returned by this method does **not** fire for physics-related
changes, such as when the `Class.BasePart.CFrame|CFrame`,
`Class.BasePart.AssemblyLinearVelocity|AssemblyLinearVelocity`,
`Class.BasePart.AssemblyAngularVelocity|AssemblyAngularVelocity`,
`Class.BasePart.Position|Position`, or
`Class.BasePart.Orientation|Orientation` properties of a `Class.BasePart`
change due to gravity. To detect changes in these properties, consider
using a physics-based event like `Class.RunService.PreSimulation`.

Additionally, the returned event may not fire on every modification of
properties that change very frequently, and/or it may not fire for such
properties at all. It's recommended that you carefully test for property
changes that impact game logic.


Object:GetPropertyChangedSignal

A signal that fires whenever the property changes.


Get an event that fires when a given property of the object changes.


Demonstrates determining the class of Workspace using `Class.Instance:IsA()`

Workspace is of class 'Workspace', so the first statement is true. Workspace
is not of class 'BasePart', so the second statement is false. Workspace
inherits from Instance and therefore is of class 'Instance', so the third
statement is true.


IsA returns true if the object's class is **equivalent to** or a
**subclass** of a given class. This function is similar to the
**instanceof** operators in other languages, and is a form of
[type introspection](https://en.wikipedia.org/wiki/Type_introspection). To
ignore class inheritance, test the `Class.Object.ClassName|ClassName`
property directly instead. For checking native Luau data types (number,
string, etc) use the functions `type` and `typeof`.

Most commonly, this function is used to test if an object is some kind of
part, such as `Class.Part` or `Class.WedgePart`, which inherits from
`Class.BasePart` (an abstract class). For example, if your goal is to
change all of a character's limbs to the same color, you might use
`Class.Instance:GetChildren()|GetChildren` to iterate over the children,
then use IsA to filter non-`Class.BasePart` objects which lack the
`Datatype.BrickColor` property:

```lua
local Players = game:GetService("Players")

local function paintFigure(character, color)
	-- Iterate over the child objects of the character
	for _, child in character:GetChildren() do
		-- Filter out non-part objects, such as Shirt, Pants and Humanoid
		-- R15 use MeshPart and R6 use Part, so we use BasePart here to detect both:
		if child:IsA("BasePart") then
			child.BrickColor = color
		end
	end
end
paintFigure(Players.Player.Character, BrickColor.new("Bright blue"))
```

Since all classes inherit from `Class.Object`, calling
`object:IsA("Object")` will always return true.


Object:IsA

className

The class against which the Object's class will be checked.
Case-sensitive.


Describes whether the Object's class matched or is a subclass of the
given class.


Returns true if an object's class matches or inherits from a given class.


Object:isA

Object

A read-only string representing the class this `Class.Object` belongs to.

This property can be used with various other functions that are used to
identify objects by type, such as `Class.Object:IsA()` or
`Class.Instance:FindFirstChildOfClass()`.

Note this property is read only and cannot be altered by scripts.
Developers wishing to change an object's class will instead have to create
a new `Class.Object`.

Unlike `Class.Object:IsA()`, ClassName can be used to check if an object
belongs to a specific class ignoring class inheritance. For example:

```
for _, child in workspace:GetChildren() do
    if child.ClassName == "Part" then
        print("Found a Part")
        -- will find Parts in model, but NOT TrussParts, WedgeParts, etc
    end
end
```


Object.ClassName

A read-only string representing the class this `Class.Object` belongs to.


Object.className

`Object` is the base class for all classes in the Roblox class hierarchy.


/reference/engine/classes/VirtualInput.yaml

Luau

Dictionary

Byte keycodes that represent the key or button involved in user input.

Enum

Enum.KeyCode

An object that runs connected functions upon a specific occurrence.

Data Type

RBXScriptSignal

Describes the type of a user input event.

Enum.UserInputType

Represents a 2D value with direction and magnitude.

Vector2

Data type having a value of either true or false.

boolean

A double-precision floating-point number.

number

A sequence of characters, such as letters, numbers, and symbols.

string

Experiences

Avatar

Assets

Samples and projects

Engine API

Open Cloud API

Studio

Analytics

Platform

Tutorials

Creator programs

Education

Courses

Learn

This method is asynchronous and returns an `Operation`, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the [documentation]({longRunningOperationsLink}) on long-running operations for more information.
            
The following sections describe the response and metadata objects that are provided when an operation completes.

Beta endpoints are ready for public use. Breaking changes are possible but rare.

These Open Cloud documentation pages will be removed on March 31, 2026. You will be automatically redirected to the new Open Cloud documentation at that time. {linkStart}Learn more{linkEnd}

These old Open Cloud pages will be removed and redirected on March 31, 2026. {linkStart}Learn more{linkEnd}

Experimental endpoints are ready for public use, but may experience breaking changes occasionally as the API contract is finalized.

This endpoint can be called in-experience through {httpServiceLinkStart}HttpService{httpServiceLinkEnd} with an API key.

This field may be set when creating a resource, but may not be modified by subsequent requests.

These fields may be set when creating a resource, but may not be modified by subsequent requests.

This field may be provided in requests, but will never be included in responses.

Legacy authentication method. Always prefer using API Key or OAuth 2.0 when available.

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

Requires no authentication to call. Typically has significantly lowered rate limits. Always prefer using API Key or OAuth 2.0 when available.

For each grouping, only one of the following fields in the schema has to be provided, the remaining can be excluded.

You can opt back in at any time. {linkStart}Provide feedback.{linkEnd}

You are viewing the old docs. {linkStart}Provide feedback.{linkEnd}

You can opt out at any time and be redirected back to the old reference pages. {linkStart}Provide feedback.{linkEnd}

You are viewing the revamped docs. {linkStart}Provide feedback.{linkEnd}

This field may be set on responses, but will be ignored in requests.

Note: Rate limits can be lower during high-traffic periods. Certain endpoints have additional rate limits. [Learn more about rate limits]({link}).

{limit} requests per day across all API keys for a user or group

{limit} requests per hour across all API keys for a user or group

{limit} requests per minute across all API keys for a user or group

{limit} requests per second across all API keys for a user or group

{limit} requests per minute per API key owner

{limit} request(s) per second per API key owner

Scopes control what permissions your credentials have. Your credentials can only access the endpoints supported by the scopes you selected.

Stable endpoints are production-ready and will almost never experience breaking changes during their lifetime.

This target enables you to limit your key's access to selected {requiredParts}

This target enables you to limit your key's access to selected {requiredParts} and {optionalParts}

Target types are used to restrict the resources that your credentials have permissions on. Only the selected resources can be acted on even if your account has permissions on additional resources. Some scopes do not have target parts. In these cases, all of your relevant resources can be acted on.

The universe Top Level Part does not need to be selected for user-owned API Keys. In this case, your API Key will have access to all of your user-owned experiences and group-owned experiences that you have the right group permissions on.

Try It Out is not yet supported for endpoints requiring API key or OAuth 2.0 authentication

Cookie authentication is disabled for high risk operations for safety.

Critical risk endpoints are extremely sensitive and Try It Out is disabled for safety

Note: Authentication headers are not included in this code sample. You may need to add an authentication header for this command to work.

This is a high risk endpoint that can modify or delete critical data. Use extreme caution when testing.

This API endpoint has been classified as HIGH RISK and may affect live data or user accounts.

Authenticated requests to high-risk APIs can make changes that cannot be undone. Please review your request parameters carefully before proceeding.

Please login to use cookie authentication

This is a low risk endpoint that retrieves data. This is generally safe to test.

This is a medium risk endpoint that modifies data. Test carefully with non-critical accounts, as changes may be permanent.

To keep your account safe, never paste text here from other sources or send information from this page to others.

You are about to test live API endpoints using your actual account credentials.

Only proceed if you understand the implications of the API calls you're about to make. Review the API documentation carefully before testing.

API calls will be made using your authenticated session

These are real API calls that may affect your account or data

Rate limits and other API restrictions apply

Some operations may modify or delete data

This endpoint has been superseded by these recommended alternative endpoints:

The following scopes are required to call this endpoint. For more
information on generating proper keys, see [Manage API keys]({apiKeyReferenceDocLink}).

For more information on generating keys, see [Manage API keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

This string is formatted as a [FieldMask](/cloud/reference/types#fieldmask).

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

For more information on how to register an OAuth 2.0 application, see [App registration and review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

The following scopes are required to call this endpoint.

Resource Paths

This string is formatted as a [Timestamp](/cloud/reference/types#timestamp).

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

Not Recommended

You are viewing the revamped Open Cloud reference.

You've opted out of the new Open Cloud reference.

View your ad campaigns and their performance.

Create, update, and manage your ad campaigns.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing asset permissions for subjects (including groups and experiences) and assets your account has access to.

This allows granting asset permissions to any subjects (including groups and experiences) and assets your account has access to.

This allows you to view the status and results of avatar auto-setup jobs on your behalf.

This allows you to create and manage avatar auto-setup jobs on your behalf.

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows making changes to your synced commerce items.

This allows viewing information about your commerce merchant connections.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to view information about your Creator Store saves.

This allows you to modify information about your Creator Store saves.

Grants access to create data stores on your behalf.

Grants access to delete data stores on your behalf.

Grants access to read a list of data stores.

Grants access to take a snapshot of your data stores.

Grants access to create entries in your data stores.

Grants access to mark specified entries for deletion.

Grants access to list your data store's entries.

Grants access to read specified entries in your data stores.

Grants access to update the value, attributes, and users of an entry.

Grants access to delete revisions of your data store's entries.

Grants access to list revisions for your data store's entries.

Grants access to read revisions of your data store's entries.

Grants access to view configuration details for the authorized user's developer products.

Grants access to edit the authorized user's developer products.

This allows viewing information about your universe's environments.

This allows editing of your universe's environments.

Grants access to view configuration details for the authorized user's game passes.

Grants access to edit the authorized user's game passes.

Grants access to view community forums information for your account.

Grants access to manage community forums information for your account.

This allows viewing information about your communities.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

Allows you to view an instance's property data.

Allows you to modify the property data of instances (currently only supports Scripts).

This allows viewing information about your inventory.

Grants access to manage your badges and spend Robux.

Grants access to update the authorized user's badges.

Grants access to manage your developer products.

Grants access to read information about the experiences you have notifications on for.

Grants access to turn on or off notifications for experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

Allows you to view the status, logs, and results of Luau execution tasks for the associated place.

Allows you to create new Luau execution tasks for the associated place.

Grants access to asynchronously flush all data structures in the universe.

Grants access to discard read items from the front of the queue.

Grants access to read items at the front of the queue.

Grants access to read your memory store items.

Grants access to create, update, and delete map items.

This grants the ability to publish messages on behalf of users.

This allows sending notifications from your experience to users.

(Deprecated) Grants access to read a list of entries in an ordered data store.

(Deprecated) Grants access to create a new entry in an ordered data store.

Grants access to list entries from an ordered data store.

Grants access to create entries in an ordered data store.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

This permission allows you to submit an evaluation job and view the job result.

Grants access to read about your subscription products.

This allows you to read thumbnail information on your behalf.

Grants the ability to read game analytics.

Grants the ability to read place information.

Grants the ability to edit place information.

Grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants access to edit the authorized user's experiences.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

This allows viewing notifications sent to your account.

Grants the ability to read the authorized user's premium and verified status.

This allows you to view the authorized user's social accounts.

This enables Single Sign-On functionality.

This grants access to read your profile information.