A service that centralizes the global dragger settings that Studio's dragging
tools read so they move, snap, and highlight objects consistently.
Its interface does not cross the network boundary.
Instances of this class cannot be created with Instance.new.
It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service, NotReplicated]
DraggerService is a central hub for dragger-related settings that Studio's
dragging tools (and other dragger-like editing UX) read when deciding how to
move, snap, and highlight objects. Because the Move, Scale, and Rotate tools
all consult the same service, changing a setting here keeps their snapping,
collision, joint, and hover behavior in sync. Each property reflects the
corresponding Studio editing preference or global editing state.
- 732
Add UseBoundingBoxes
- 684
Change Tags of ShowHover
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of PivotSnapToGeometry
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of PartSnapEnabled
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of LinearSnapIncrement
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of LinearSnapEnabled
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of JointsEnabled
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of HoverThickness
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of HoverLineThickness
from
[Hidden, ReadOnly, NotReplicated]
to
[Hidden]
- 684
Change Tags of HoverAnimateFrequency
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of GeometrySnapColor
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of DraggerMovementMode
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of DraggerCoordinateSpace
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of CollisionsEnabled
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of AnimateHover
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of AngleSnapIncrement
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of AngleSnapEnabled
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 684
Change Tags of AlignDraggedObjects
from
[ReadOnly, NotReplicated]
to
[NotReplicated]
- 623
Add PartSnapEnabled
- 553
Change Default of ShowPivotIndicator
from
to
- 553
Change Default of ShowHover
from
to
- 553
Change Default of PivotSnapToGeometry
from
to
- 553
Change Default of LinearSnapIncrement
from
to
- 553
Change Default of LinearSnapEnabled
from
to
- 553
Change Default of JointsEnabled
from
to
- 553
Change Default of HoverThickness
from
to
- 553
Change Default of HoverLineThickness
from
to
- 553
Change Default of HoverAnimateFrequency
from
to
- 553
Change Default of GeometrySnapColor
from
to
- 553
Change Default of DraggerMovementMode
from
to
- 553
Change Default of DraggerCoordinateSpace
from
to
- 553
Change Default of CollisionsEnabled
from
to
- 553
Change Default of AnimateHover
from
to
- 553
Change Default of AngleSnapIncrement
from
to
- 553
Change Default of AngleSnapEnabled
from
to
- 553
Change Default of AlignDraggedObjects
from
to
- 547
Add HoverLineThickness
- 486
Change ThreadSafety of ShowPivotIndicator
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of ShowHover
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of PivotSnapToGeometry
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of LinearSnapIncrement
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of LinearSnapEnabled
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of JointsEnabled
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of HoverThickness
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of HoverAnimateFrequency
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of GeometrySnapColor
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of DraggerMovementMode
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of DraggerCoordinateSpace
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of CollisionsEnabled
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of AnimateHover
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of AngleSnapIncrement
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of AngleSnapEnabled
from
ReadOnly
to
ReadSafe
- 486
Change ThreadSafety of AlignDraggedObjects
from
ReadOnly
to
ReadSafe
- 481
Add ShowPivotIndicator
- 481
Add ShowHover
- 481
Add PivotSnapToGeometry
- 481
Add LinearSnapIncrement
- 481
Add LinearSnapEnabled
- 481
Add JointsEnabled
- 481
Add HoverThickness
- 481
Add HoverAnimateFrequency
- 481
Add GeometrySnapColor
- 481
Add DraggerMovementMode
- 481
Add DraggerCoordinateSpace
- 481
Add CollisionsEnabled
- 481
Add AnimateHover
- 481
Add AngleSnapIncrement
- 481
Add AngleSnapEnabled
- 481
Add AlignDraggedObjects
- 481
Add DraggerService
When true, a dragged object is rotated to align with the surface it is
dropped on instead of keeping its original orientation. This reflects
Studio's "Align Dragged Objects" editing preference and is read by the
dragging tools.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
When true, rotating an object with a dragger snaps the rotation to
multiples of DraggerService.AngleSnapIncrement. When false,
rotation is continuous and the increment has no effect.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
The rotation snapping step, in degrees, applied while
DraggerService.AngleSnapEnabled is true; it has no effect when
angle snapping is disabled. The value is clamped to a small positive
minimum, so it can never be set to 0 or a negative number.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
When true, dragging performs collision checking so that a moved object
stops against other parts instead of passing through them. When false,
objects can be dragged freely through existing geometry.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
The Color3 used to draw the snapping indicators (such as
pivot-to-geometry snap points) shown while dragging. It reflects the
corresponding Studio color preference.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
How fast the hover highlight pulses, in cycles per second, when
DraggerService.AnimateHover is true. The value corresponds to
Studio's hover-animation speed preference, which ranges from 0.5 (very
slow) to 10 (very fast).
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
It is not meant to be used, and may have unresolved issues.
History 3
Tags: [Hidden]
The thickness of the outline drawn around the object beneath the cursor.
It is only visible when DraggerService.ShowHover is true, and
reflects Studio's hover-outline thickness preference.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
When true, parts that come to rest against other surfaces during a drag
are joined to them (for example, surface welds) when the drag finishes.
When false, dragging does not create joints.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
When true, moving an object with a dragger snaps its position to a grid
whose spacing is DraggerService.LinearSnapIncrement. When false,
movement is continuous and the increment has no effect.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
The spacing, in studs, of the movement grid applied while
DraggerService.LinearSnapEnabled is true; it has no effect when
linear snapping is disabled. The value is clamped to a small positive
minimum, so it can never be set to 0 or a negative number.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
When true, dragging snaps the moved object to salient points (such as
edges and corners) on nearby parts, in addition to any grid snapping. When
false, part-to-part snapping is off.
Its interface does not cross the network boundary.
History 2
Tags: [NotReplicated]
When true, dragging an object's pivot snaps it to points on surrounding
geometry (for example vertices, edges, and face centers). When false,
the pivot moves freely.
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
Its interface does not cross the network boundary.
History 4
Tags: [NotReplicated]
When true, the pivot indicator (the marker showing an object's pivot
point) is shown while dragging. Defaults to false.
Its interface does not cross the network boundary.
History 3
Tags: [NotReplicated]
When true, the dragging tools use the axis-aligned bounding box of an
object for snapping instead of its precise geometric shape. This can
simplify placement when objects have complex geometry. The setting
corresponds to Studio's "Use Bounding Boxes" option in the
dragger-settings ribbon dropdown. Defaults to false.
Its interface does not cross the network boundary.
History 1
Tags: [NotReplicated]