roblox-input

Original：🇺🇸 English

Translated

UserInputService, ContextActionService, keyboard/mouse/gamepad/touch, cross-platform input binding.

12installs

Sourcetabooharmony/roblox-brain

Added on2026-07-03

NPX Install

npx skill4agent add tabooharmony/roblox-brain roblox-input

SKILL.md Content

View Translation Comparison →

When to Load

Load when handling keyboard, mouse, gamepad, touch, accelerometer, or gyroscope input; binding actions across platforms; or detecting what input devices the player has. Client-only — both services require

LocalScript

or client

RunContext

.

Quick Reference

Core events (

UserInputService

):

InputBegan

,

InputChanged

,

InputEnded

fire as

(input: InputObject, gameProcessedEvent: boolean)

.

InputBegan

does NOT fire for mouse wheel. Events only fire while the client window is focused.

Platform detection (cache at startup):

KeyboardEnabled

,

MouseEnabled

,

TouchEnabled

,

GamepadEnabled

,

AccelerometerEnabled

,

GyroscopeEnabled

,

VREnabled

,

PreferredInput

(the device the player is currently using most).

Polling queries (cheaper than events for held-state):

luau

UIS:IsKeyDown(Enum.KeyCode.W)
UIS:IsMouseButtonPressed(Enum.UserInputType.MouseButton1)
UIS:IsGamepadButtonDown(Enum.UserInputType.Gamepad1, Enum.KeyCode.ButtonA)
local dx, dy = UIS:GetMouseDelta()

Prefer
ContextActionService
over
InputBegan
for gameplay — free conflict resolution (chat won't steal H) and free mobile buttons:

luau

local CAS = game:GetService("ContextActionService")

local function onAction(name, state, _input)
    if name == "Jump" and state == Enum.UserInputState.Begin then
        humanoid.Jump = true
    end
end

CAS:BindAction("Jump", onAction, true,
    Enum.KeyCode.Space, Enum.KeyCode.ButtonA)

BindAction(name, handler, createTouchButton, ...inputTypes)

. Handler returns

ContextActionResult.Sink

to consume,

.Pass

to fall through.

Touch buttons:

createTouchButton=true

auto-creates an

ImageButton

under

PlayerGui.ContextActionGui.ContextButtonFrame

(max 7). Customize via

CAS:GetButton(name)

→

SetTitle

/

SetImage

/

SetPosition

/

SetDescription

.

Gamepad:

GetConnectedGamepads()

→

Gamepad1

..

Gamepad8

. Listen to

GamepadConnected

/

Disconnected

.

Touch gestures:

TouchTap

,

TouchTapInWorld

(world pos),

TouchPan

,

TouchPinch

,

TouchRotate

,

TouchSwipe

,

TouchLongPress

,

TouchDrag

. Raw:

TouchStarted

/

TouchMoved

/

TouchEnded

.

Pitfalls:

```
gameProcessedEvent=true
```
in InputBegan → UI consumed it. Filter for gameplay.
```
BindAction
```
is stack-based: most-recent wins. Use
```
BindActionAtPriority
```
.
Client-only. Server scripts silently no-op.
```
JumpRequest
```
fires multiple times per jump — debounce.
Mouse wheel only fires
```
InputChanged
```
.

See

references/full.md

for full event tables,

ContextActionResult

, mobile buttons, sensors.

roblox-input

NPX Install

Tags

SKILL.md Content

When to Load

Quick Reference