TouchLongPress

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Event of:

Description:

Fired when a user holds at least one finger for a short amount of time on the same screen position of a TouchEnabled device.

This event can be used to determine when a user holds their finger down on an an-game GuiObject|GUI or element.

The example below prints the Enum/UserInputState|state of the long press when the user user holds at least one finger for a short amount of time on the same screen position. Possible states include: Begin, Change, End, Cancel, and None.

local userInputService = game:GetService("UserInputService")

function TouchLongPress(TouchPositions, state, gameProcessedEvent)
	print("Long press event fired. State of press: "..tostring(state))
end

userInputService.TouchLongPress:Connect(TouchLongPress)

To check if a user’s device is TouchEnabled, and that touch events will fire, seeUserInputService/TouchEnabled.

It can be paired with UserInputService/TouchStarted and UserInputService/TouchEnded to determine when a user starts and stops touching the screen.

This event only fires when the Roblox client window is in focus. For example, inputs will not be captured when the window is minimized.

As this event only fires locally, it can only be used in a LocalScript.

Parameters

Name	Type	Default	Description
Name touchPositions	Type Array	Default	Summary An array of `DataType/Vector2`s, indicating the position of the fingers involved in the gesture
Name state	Type UserInputState	Default	Summary The `Enum/UserInputState` of the gesture
Name gameProcessedEvent	Type bool	Default	Summary Indicates whether the game engine internally observed this input and acted on it. Generally this refers to UI processing, so if a button was touched or clicked from this input, `gameProcessedEvent` would be true. This is also true for input events connected via `ContextActionService`

Code Samples

The Difference Between TouchTap and TouchLongPress

The code sample below demonstrates the difference between a UserInputService/TouchTap|TouchTap and UserInputService/TouchLongPress|TouchLongPress by creating a GuiObject|GUI Frame that appears when user touches the screen of their device and disappears when the UserInputEvent/TouchEnded|touch ends. When the long press event fires, the GUI doubles in size. Also, the GUI moves to stay centered under the user’s finger when the player moves their finger.

In order for the UserInputService/TouchLongPress|TouchLongPress to fire, the user touch the screen and hold their finger still for a short period of time. Once the touch moves, the long press event will not fire.

In order for the example to work as expected, it should be placed in a LocalScript that is parented to a ScreenGui.

			
				The Difference Between TouchTap and TouchLongPress

				Expected Output
			
				Expand
				
			local UserInputService = game:GetService("UserInputService")

-- The parent of this script (a ScreenGui)
local touchScreenGui = script.Parent

-- Create the GUI frame that the user interacts with through Touch
-- events
local touchGui = Instance.new("Frame")
touchGui.Name = "TouchGui"
touchGui.AnchorPoint = Vector2.new(0.5, 0.5)

-- Fires when the touches their device’s screen
local function TouchTap(touchPositions, gameProcessedEvent)
	touchGui.Parent = touchScreenGui
	touchGui.Position = UDim2.new(0, touchPositions[1].X, 0, touchPositions[1].Y)
	touchGui.Size = UDim2.new(0,50,0,50)
end

-- Fires when a user starts touching their device's screen and does not
-- move their finger for a short period of time
local function TouchLong(touchPositions, state, gameProcessedEvent)
	touchGui.Size = UDim2.new(0,100,0,100)
end

-- Fires when the user moves their finger while touching their device's
-- screen
local function TouchMove(touch, gameProcessedEvent)
	touchGui.Position = UDim2.new(0, touch.Position.X, 0, touch.Position.Y)
end

-- Fires when the user stops touching their device's screen
local function TouchEnd(touch, gameProcessedEvent)
	touchGui.Parent = nil
	touchGui.Size = UDim2.new(0,50,0,50)
end

-- Only use the Touch events if the user is on a mobile device
if UserInputService.TouchEnabled then
	UserInputService.TouchTap:Connect(TouchTap)
	UserInputService.TouchLongPress:Connect(TouchLong)
	UserInputService.TouchMoved:Connect(TouchMove)
	UserInputService.TouchEnded:Connect(TouchEnd)
end
		
				Copy Code
			
				Light Theme

TouchLongPress

See also

Parameters

touchPositions

state

gameProcessedEvent

Code Samples

The Difference Between TouchTap and TouchLongPress