DragBegin

Deprecated

This event, as well as its counterparts, GuiObject/DragStopped and GuiObject/Draggable, have all been deprecated. None should be used for new work

Unsafe

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

Event of:

GuiObject

Description:

This event fires when a player begins dragging the object.

Parameters

Name	Type	Default	Description
Name initialPosition	Type UDim2	Default	Summary A `UDim2` value of the position of the `GuiObject` before any drag operation began

Code Samples

(Deprecated) Print the Position of a GUI When Dragging Begins

The below example assumes it’s within a GuiObject such as a TextButton, and that the /GuiObject/Draggable property is set to true. It will print the UDim2 of where the player started dragging the object from.

			
				(Deprecated) Print the Position of a GUI When Dragging Begins

				Expected Output
			
				Expand
				
			script.Parent.DragBegin:Connect(function(UD2)
	local XScale, XOffset, YScale, YOffset = UD2.X.Scale, UD2.X.Offset, UD2.Y.Scale, UD2.Y.Offset
	print(("The player started dragging the object at UDim2.new(%f, %d, %f, %d)"):format(XScale, XOffset, YScale, YOffset))
end)
		
				Copy Code
			
				Light Theme

DragBegin

See also

Parameters

initialPosition

Code Samples

(Deprecated) Print the Position of a GUI When Dragging Begins