ContextActionService

Why use ContextActionService?

ContextActionService maps inputs to an action callback. It can also create touch controls when requested, making it useful for controls intended to work beyond a single keyboard key.

Try it in Roblox Studio

Put this LocalScript in StarterPlayerScripts. Test E and a gamepad X button in Studio; on a touch device the service may display a touch button.

Syntax

ContextActionService:BindAction(name, callback, true, Enum.KeyCode.E)

Examples

Bind an interaction action and ignore End events.

local ContextActionService = game:GetService("ContextActionService")
local function interact(actionName, inputState)
    if inputState == Enum.UserInputState.Begin then
        print(actionName, "started")
    end
    return Enum.ContextActionResult.Pass
end

ContextActionService:BindAction(
    "PracticeInteract", interact, true,
    Enum.KeyCode.E, Enum.KeyCode.ButtonX
)

BindAction associates a unique name with a callback and input keys.
The third argument requests a touch button. The callback checks Begin so one press is not handled again on End.
Returning Pass allows other bound handlers to see the input. UnbindAction when this control is no longer needed.

Best practices

Give every action a distinctive name and unbind it when its UI or mode ends.
Test mouse, touch and gamepad behavior instead of assuming one control scheme.

Runtime & versions

Luau host; Roblox engine examples require Roblox Studio. Feature availability depends on the language and runtime version used by your project; consult the official reference below.

Luau documentation

Why use ContextActionService?

Try it in Roblox Studio

Syntax

Examples