TouchSwipe

Unsafe

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

Event of:

Description:

The TouchSwipe event fires when the player performs a swipe gesture on the UI element using a touch-enabled device. It fires with the direction of the gesture (Up, Down, Left or Right) and the number of touch points involved in the gesture. Swipe gestures are often used to change tabs in mobile UIs.

Since this event only requires one finger, this event can be simulated in Studio using the emulator and a mouse. Below is an example of TouchSwipe being fired on a Frame that is GuiObject/Active. Below, the event fires when the Frame moves and changes color slightly. The code for this can be found the code samples.

TouchSwipe event firing on a Frame

Parameters

Name	Type	Default	Description
Name swipeDirection	Type SwipeDirection	Default	Summary A `Enum/SwipeDirection` indicating the direction of the swipe gesture (Up, Down, Left or Right)
Name numberOfTouches	Type int	Default	Summary The number of touch points involved in the gesture (usually 1)

Code Samples

Bouncing Color Picker

This code sample will cause a Frame (or other GuiObject) to bounce when a swipe gesture is performed on a touch-enabled device (or Studio’s emulator). Horizontal swipes will change the hue of the GuiObject/BackgroundColor3, while vertical swipes will change the saturation.

			
				Bouncing Color Picker

				Expected Output
			
				Expand
				
			local frame = script.Parent
frame.Active = true

-- How far the frame should bounce on a successful swipe
local BOUNCE_DISTANCE = 50

-- Current state of the frame
local basePosition = frame.Position
local hue = 0
local saturation = 128

local function updateColor()
	frame.BackgroundColor3 = Color3.fromHSV(hue/256, saturation/256, 1)
end

local function onTouchSwipe(swipeDir, touchCount)
	-- Change the BackgroundColor3 based on the swipe direction
	local deltaPos
	if swipeDir == Enum.SwipeDirection.Right then
		deltaPos = UDim2.new(0, BOUNCE_DISTANCE, 0, 0)
		hue = (hue + 16) % 255
	elseif swipeDir == Enum.SwipeDirection.Left then
		deltaPos = UDim2.new(0, -BOUNCE_DISTANCE, 0, 0)
		hue = (hue - 16) % 255
	elseif swipeDir == Enum.SwipeDirection.Up then
		deltaPos = UDim2.new(0, 0, 0, -BOUNCE_DISTANCE)
		saturation = (saturation + 16) % 255
	elseif swipeDir == Enum.SwipeDirection.Down then
		deltaPos = UDim2.new(0, 0, 0, BOUNCE_DISTANCE)
		saturation = (saturation - 16) % 255
	else
		deltaPos = UDim2.new()
	end
	-- Update the color and bounce the frame a little
	updateColor()
	frame.Position = basePosition + deltaPos
	frame:TweenPosition(basePosition, Enum.EasingDirection.Out, Enum.EasingStyle.Bounce, .7, true)
end

frame.TouchSwipe:Connect(onTouchSwipe)
updateColor()
		
			The Frame will bounce and change color in a direction when you perform a swipe gesture on it using a touch-enabled device (or Studio's emulator).
		
				Copy Code
			
				Light Theme

TouchSwipe

See also

Parameters

swipeDirection

numberOfTouches

Code Samples

Bouncing Color Picker