InputObject

An InputObject is a table describing one client input. Scripts do not construct it directly. A client LocalScript receives it from UserInputService signals such as InputBegan and InputEnded.

The signal callback also receives gameProcessed, a Boolean that reports whether the engine already handled the input. Gameplay controls commonly return early when it is true, which prevents typing in chat or using an engine control from also triggering the game action.

Properties

KeyCode

EnumItem

The keyboard key associated with the input.

Keyboard input supplies the matching Enum.KeyCode item. Mouse buttons use Enum.KeyCode.Unknown, so use UserInputType to distinguish mouse buttons.

UserInputType

EnumItem

The device action that produced the input.

Examples include Enum.UserInputType.Keyboard, MouseButton1, and MouseButton2.

Position

Vector3

Positional data supplied with the input.

Delta

Vector3

The change in position supplied with the input.

Keyboard and mouse example

local UserInputService = game:GetService("UserInputService")

UserInputService.InputBegan:Connect(function(input, gameProcessed)
    if gameProcessed then
        return
    end

    if input.UserInputType == Enum.UserInputType.Keyboard
        and input.KeyCode == Enum.KeyCode.E then
        print("E was pressed")
    elseif input.UserInputType == Enum.UserInputType.MouseButton1 then
        print("The left mouse button was pressed")
    end
end)

Compare enum items directly. Do not compare KeyCode or UserInputType with strings such as "E" or "MouseButton1".

Vortex Studio 0.3.8 notes

InputBegan delivered InputObjects as tables in a LocalScript. Keyboard input reported Enum.UserInputType.Keyboard and its actual KeyCode. Left and right mouse buttons reported MouseButton1 and MouseButton2, with Enum.KeyCode.Unknown.

Position and Delta were exposed as Vector3 values, but both remained (0, 0, 0) for the tested keyboard and mouse-button inputs. Do not treat them as confirmed mouse-cursor coordinates in this release.

UserInputState, Changed, and IsModifierKeyDown read as nil. Touch and gamepad InputObjects were not tested.