InputObject
An object created when an input begins that describes a particular user input.
Memory category | Instances |
---|
Member index 6
Description
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
.
History 23
- 553 Change Default of UserInputType from to None
- 553 Change Default of UserInputState from to None
- 553 Change Default of Position from to Vector3(0, 0, 0)
- 553 Change Default of KeyCode from to Unknown
- 553 Change Default of Delta from to Vector3(0, 0, 0)
- 486 Change ThreadSafety of UserInputType from ReadOnly to ReadSafe
- 486 Change ThreadSafety of UserInputState from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Position from ReadOnly to ReadSafe
- 486 Change ThreadSafety of KeyCode from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Delta from ReadOnly to ReadSafe
- 462 Change ThreadSafety of IsModifierKeyDown from to Unsafe
- 462 Change ThreadSafety of UserInputType from to ReadOnly
- 462 Change ThreadSafety of UserInputState from to ReadOnly
- 462 Change ThreadSafety of Position from to ReadOnly
- 462 Change ThreadSafety of KeyCode from to ReadOnly
- 462 Change ThreadSafety of Delta from to ReadOnly
- 408 Add IsModifierKeyDown
- 158 Add Delta
- 133 Add UserInputType
- 133 Add UserInputState
- 133 Add Position
- 133 Add KeyCode
- 133 Add InputObject
Members 6
Delta
Type | Default | |
---|---|---|
Vector3 | 0, 0, 0 |
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.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
IsModifierKeyDown
Parameters (1) | ||
---|---|---|
modifierKey | ModifierKey | |
Returns (1) | ||
bool |
Returns true
if the passed in modifierKey
such as
Shift is being held down.
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of IsModifierKeyDown from to Unsafe
- 408 Add IsModifierKeyDown
KeyCode
Type | Default | |
---|---|---|
KeyCode | Unknown |
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.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
Position
Type | Default | |
---|---|---|
Vector3 | 0, 0, 0 |
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 (1
), backwards (-1
), 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.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
UserInputState
Type | Default | |
---|---|---|
UserInputState | None |
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.
Thread safety | ReadSafe |
---|---|
Category | State |
Loaded/Saved | false |
History 4
- 553 Change Default of UserInputState from to None
- 486 Change ThreadSafety of UserInputState from ReadOnly to ReadSafe
- 462 Change ThreadSafety of UserInputState from to ReadOnly
- 133 Add UserInputState
UserInputType
Type | Default | |
---|---|---|
UserInputType | None |
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.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | false |
History 4
- 553 Change Default of UserInputType from to None
- 486 Change ThreadSafety of UserInputType from ReadOnly to ReadSafe
- 462 Change ThreadSafety of UserInputType from to ReadOnly
- 133 Add UserInputType