Skip to main content

Touch

This item only works when running on the client. Client

The Touch class is part of the Input package.

local Touch = require(packages.Input).Touch

Properties​

TouchTap​

Event
</>
Touch.TouchTap: Signal<(
touchPositions: {Vector2},
processed: boolean
)>

TouchTapInWorld​

Event
</>
Touch.TouchTapInWorld: Signal<(
position: Vector2,
processed: boolean
)>

TouchMoved​

Event
</>
Touch.TouchMoved: Signal<(
touch: InputObject,
processed: boolean
)>

TouchLongPress​

Event
</>
Touch.TouchLongPress: Signal<(
touchPositions: {Vector2},
state: Enum.UserInputState,
processed: boolean
)>

TouchPan​

Event
</>
Touch.TouchPan: Signal<(
touchPositions: {Vector2},
totalTranslation: Vector2,
velocity: Vector2,
state: Enum.UserInputState,
processed: boolean
)>

TouchPinch​

Event
</>
Touch.TouchPinch: Signal<(
touchPositions: {Vector2},
scale: number,
velocity: Vector2,
state: Enum.UserInputState,
processed: boolean
)>

TouchRotate​

Event
</>
Touch.TouchRotate: Signal<(
touchPositions: {Vector2},
rotation: number,
velocity: number,
state: Enum.UserInputState,
processed: boolean
)>

TouchSwipe​

Event
</>
Touch.TouchSwipe: Signal<(
swipeDirection: Enum.SwipeDirection,
numberOfTouches: number,
processed: boolean
)>

TouchStarted​

Event
</>
Touch.TouchStarted: Signal<(
touch: InputObject,
processed: boolean
)>

TouchEnded​

Event
</>
Touch.TouchEnded: Signal<(
touch: InputObject,
processed: boolean
)>

Functions​

new​

</>
Touch.new() → ()

Constructs a new Touch input capturer.

IsTouchEnabled​

</>
Touch:IsTouchEnabled() → boolean

Returns the value of UserInputService.TouchEnabled.

Destroy​

</>
Touch:Destroy() → ()

Destroys the Touch input capturer.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new Touch input capturer.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 89,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "IsTouchEnabled",
            "desc": "Returns the value of [`UserInputService.TouchEnabled`](https://developer.roblox.com/en-us/api-reference/property/UserInputService/TouchEnabled).",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 111,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the Touch input capturer.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 118,
                "path": "src/input/src/Input/Touch.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "TouchTap",
            "desc": "Proxy for [UserInputService.TouchTap](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchTap).",
            "lua_type": "Signal<(touchPositions: {Vector2}, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 31,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchTapInWorld",
            "desc": "Proxy for [UserInputService.TouchTapInWorld](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchTapInWorld).",
            "lua_type": "Signal<(position: Vector2, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 37,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchMoved",
            "desc": "Proxy for [UserInputService.TouchMoved](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchMoved).",
            "lua_type": "Signal<(touch: InputObject, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 43,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchLongPress",
            "desc": "Proxy for [UserInputService.TouchLongPress](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchLongPress).",
            "lua_type": "Signal<(touchPositions: {Vector2}, state: Enum.UserInputState, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 49,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchPan",
            "desc": "Proxy for [UserInputService.TouchPan](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchPan).",
            "lua_type": "Signal<(touchPositions: {Vector2}, totalTranslation: Vector2, velocity: Vector2, state: Enum.UserInputState, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 55,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchPinch",
            "desc": "Proxy for [UserInputService.TouchPinch](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchPinch).",
            "lua_type": "Signal<(touchPositions: {Vector2}, scale: number, velocity: Vector2, state: Enum.UserInputState, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 61,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchRotate",
            "desc": "Proxy for [UserInputService.TouchRotate](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchRotate).",
            "lua_type": "Signal<(touchPositions: {Vector2}, rotation: number, velocity: number, state: Enum.UserInputState, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 67,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchSwipe",
            "desc": "Proxy for [UserInputService.TouchSwipe](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchSwipe).",
            "lua_type": "Signal<(swipeDirection: Enum.SwipeDirection, numberOfTouches: number, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 73,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchStarted",
            "desc": "Proxy for [UserInputService.TouchStarted](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchStarted).",
            "lua_type": "Signal<(touch: InputObject, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 79,
                "path": "src/input/src/Input/Touch.lua"
            }
        },
        {
            "name": "TouchEnded",
            "desc": "Proxy for [UserInputService.TouchEnded](https://developer.roblox.com/en-us/api-reference/event/UserInputService/TouchEnded).",
            "lua_type": "Signal<(touch: InputObject, processed: boolean)>",
            "tags": [
                "Event"
            ],
            "source": {
                "line": 85,
                "path": "src/input/src/Input/Touch.lua"
            }
        }
    ],
    "types": [],
    "name": "Touch",
    "desc": "The Touch class is part of the Input package.\n\n```lua\nlocal Touch = require(packages.Input).Touch\n```",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 22,
        "path": "src/input/src/Input/Touch.lua"
    }
}