v1.6.15 / Classes

InputObject

extends Instance

Class fields

Field	XML type	Value
`Name`	string	InputObject
`summary`	string	An object that describes a particular user input, such as mouse movement, touches, keyboard, and more.

Properties

5

Delta

Vector3

Field	XML type	Value
`Name`	string	Delta

KeyCode

KeyCode

Field	XML type	Value
`Name`	string	KeyCode
`summary`	string	An enum that describes what kind of input is being pressed. For types of input like Keyboard, this describes what key was pressed. For input like mousebutton, this provides no additional information.

Position

Vector3

Field	XML type	Value
`Name`	string	Position
`summary`	string	A Vector3 value that describes a 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. For mouse wheel input, the z component describes whether the wheel was moved forward or backward.

UserInputState

UserInputState

Field	XML type	Value
`Name`	string	UserInputState
`summary`	string	An enum that describes what state of a particular input (touch began, touch moved, touch ended, etc.). See Enum.UserInputState for more info.

UserInputType

UserInputType

Field	XML type	Value
`Name`	string	UserInputType
`summary`	string	An enum that describes what kind of input this object is describing (mousebutton, touch, etc.). See Enum.UserInputType for more info.