9 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

InputObject

Inherits from: Instance → Object

An InputObject represents a single user input, such as mouse movement, touches, key presses and more. It is created when an input begins.

The properties of this object vary according the UserInputType. Each kind of input will undergo various changes to its UserInputState. During the lifetime of an input, other properties which further describe the input may change, such as Position and Delta. Keyboard and gamepad button presses will have the KeyCode property set.

Once created at the beginning of an input, the same object persists and is updated until the input ends. As a result, you can track the object's changes using the Changed event as the user changes the input in question. You can also place these objects into a list of active inputs track and interact with the object after it's creation by an event such as UserInputService.InputBegan. This is mostly useful for touch events, as each touch point will have a separate InputObject.

See also UserInputService whose events and functions often use InputObject, and GuiObject whose events related to user input use InputObject.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable

Properties

Name	Type / Returns	Description
InputObject.Delta	Vector3	A `Vector3` describing the delta between input movements.
InputObject.KeyCode	KeyCode	Contains an Enum that describes the kind of input used.
InputObject.Position	Vector3	A `Vector3` describing the positional value of this input.
InputObject.UserInputState	UserInputState	Describes the state of an input being performed, following a specific flow depending on the `UserInputType`.
InputObject.UserInputType	UserInputType	Describes the kind of input being performed (mouse, keyboard, gamepad, touch, etc.).

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

InputObject.Delta

A Vector3 describing the delta (change) between input movements.

This is useful when used with the input's Position to track the position and movement of the user's input, such as when you're creating custom movement or camera scripts. Consider tracking input object changes using the Object.Changed event or when user input changes via events such as UserInputService.InputChanged and GuiObject.InputChanged.

Note that an InputObject corresponding to UserInputType.MouseButton1 (left click) and UserInputType.MouseButton2 (right click) supplied from an InputBegan callback will not have its Delta or Position updated once created, except for when the mouse input ends. In order to get updated deltas for mouse inputs, you must instead reference an InputObject from an InputChanged callback, or call GetMouseDelta(). However, any InputObjects corresponding to touch inputs will have their delta and position updated every frame throughout their lifetime.

Field	Value
type	Vector3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Input"]

InputObject.KeyCode

Contains a KeyCode enum that describes what kind of input was used. For types of input like keyboard, this describes what key was pressed. For inputs like the mouse, this provides no additional information.

Field	Value
type	KeyCode
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Input"]

InputObject.Position

A Vector3 describing the positional value of this input.

For mouse and touch input, this is the screen position of the mouse/touch, described in the X and Y components. The inset applied to GUI elements (such as from the top bar) is accounted for in the position. For the mouse wheel input, the Z component describes whether the wheel was moved forward (positive number), backwards (negative number), or not at all (0).

Note that an InputObject corresponding to UserInputType.MouseButton1 (left click) and UserInputType.MouseButton2 (right click) supplied from an InputBegan callback will not have its Delta or Position updated once created, except for when the mouse input ends. In order to get updated positions for mouse inputs, you must instead reference an InputObject from an InputChanged callback, or call GetMouseLocation(). However, any InputObjects corresponding to touch inputs will have their delta and position updated every frame throughout their lifetime.

Field	Value
type	Vector3
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Input"]

InputObject.UserInputState

This property describes the state of an input being performed, following a specific flow depending on the UserInputType. It uses the enum of the same name, UserInputState.

Field	Value
type	UserInputState
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	State
serialization	{"can_load":false,"can_save":false}
capabilities	["Input"]

InputObject.UserInputType

This property describes the kind of input this InputObject represents, such as mouse, keyboard, touch, or gamepad input. It uses the enum of the same name, UserInputType.

Field	Value
type	UserInputType
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":false,"can_save":false}
capabilities	["Input"]

Methods

Name	Type / Returns	Description
InputObject:IsModifierKeyDown	boolean	Returns whether the passed in modifier key is down.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

InputObject:IsModifierKeyDown

Returns true if the passed in modifierKey such as Shift is being held down.

Parameters

Name	Type	Default	Description
modifierKey	ModifierKey		The `ModifierKey` to check.

Returns

Type	Description
boolean	`true` if the passed in `modifierKey` is being held down; `false` otherwise.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Input"]

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.