InputObject

A Vector3 describing the Delta (change) between mouse/joystick movements.

This is useful when used with the input's position to track the position and movement of the user's mouse/joystick, 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 Enum.UserInputType.MouseButton1 (left click) and Enum.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.

See also:

• InputObject.KeyCode
• InputObject.Position
• InputObject.UserInputState
• InputObject.UserInputType

Contains a Enum.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.

Enums

See also:

• InputObject.Delta
• InputObject.Position
• InputObject.UserInputState
• InputObject.UserInputType

This property describes a Vector3 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 (1), backwards (-1), or not at all (0).

For Enum.KeyCode input, this indicates the position of the player's Mouse.

Note that an InputObject corresponding to Enum.UserInputType.MouseButton1 (left click) and Enum.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.

See also

• InputObject.Delta
• InputObject.KeyCode
• InputObject.UserInputState
• InputObject.UserInputType

UserInputState describes the state of an input being performed, following a specific flow depending on the UserInputType. It uses the enum of the same name, Enum.UserInputState. See the enum page for a list of all possible values for this property.

See also:

• InputObject.Delta
• InputObject.KeyCode
• InputObject.Position
• InputObject.UserInputType

UserInputType is a property that describes for what kind of input this InputObject represents, such as mouse, keyboard, touch or gamepad input. It uses the enum of the same name, Enum.UserInputType. See the enum page for a list of all possible values for this property.

See also:

• InputObject.Delta
• InputObject.KeyCode
• InputObject.Position
• InputObject.UserInputState

Parameters

Returns