Enhance draggable function documentation with options

Added detailed options for the draggable function, including axis constraints, smoothing, and drag event callbacks.
This commit is contained in:
sindri 2026-03-03 13:33:06 +01:00 committed by GitHub
parent 8d2847c4fa
commit ef4c336650
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -64,15 +64,25 @@ Creates an Action that makes a GuiObject draggable using input events (mouse and
draggable(opts: DraggableOptions?) -> Action
```
DraggableOptions
• axis: "x" | "y" | "both" (default "both")
Constrains dragging to a single axis or allows free movement.
• smoothTime: number (optional, default 0)
Enables smoothing/“weight” while dragging. 0 disables smoothing. Practical range: 0.050.12.
• onDragStart: (startPos: UDim2) -> () (optional)
Called when dragging begins. Receives the starting Position.
• onDrag: (newPos: UDim2) -> () (optional)
Called while dragging. Receives the updated Position.
• onDragEnd: (endPos: UDim2) -> () (optional)
Called when dragging ends. Receives the final Position.