Roblox UtilitiesDevlHub Roblox Documentation

Class

DraggerService

NotCreatableServiceNotReplicated
Inherits
Instance › Object
Memory category
Instances

A service that centralizes the global dragger settings that Studio's dragging tools read so they move, snap, and highlight objects consistently.

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.

Properties 18#

AlignDraggedObjectsbooleanWhether a dragged object is re-aligned to the surface it is dropped onto.ReadSafeNotReplicated
AngleSnapEnabledbooleanWhether rotation drags snap to multiples of DraggerService.AngleSnapIncrement.ReadSafeNotReplicated
AngleSnapIncrementfloatThe angle, in degrees, that rotation drags snap to.ReadSafeNotReplicated
AnimateHoverbooleanWhether the hover highlight pulses instead of staying static.ReadSafeNotReplicated
CollisionsEnabledbooleanWhether draggers prevent a moved object from overlapping other geometry.ReadSafeNotReplicated
DraggerCoordinateSpaceDraggerCoordinateSpaceWhether drag transforms are applied in the object's local space or in world space.ReadSafeNotReplicated
DraggerMovementModeDraggerMovementModeWhether dragging moves objects geometrically or by respecting physical constraints.ReadSafeNotReplicated
GeometrySnapColorColor3The color of the on-screen indicators drawn when a drag snaps to geometry.ReadSafeNotReplicated
HoverAnimateFrequencyfloatThe frequency, in hertz, at which the hover highlight animates.ReadSafeNotReplicated
HoverThicknessfloatThe thickness of the highlight outline drawn around the object under the cursor.ReadSafeNotReplicated
JointsEnabledbooleanWhether draggers create surface joints between touching parts when a drag ends.ReadSafeNotReplicated
LinearSnapEnabledbooleanWhether positional drags snap to a grid of DraggerService.LinearSnapIncrement.ReadSafeNotReplicated
LinearSnapIncrementfloatThe grid size, in studs, that positional drags snap to.ReadSafeNotReplicated
PartSnapEnabledbooleanWhether draggers snap to alignment points on nearby parts.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafeNotReplicated
PivotSnapToGeometrybooleanWhether an object's pivot snaps to points on nearby geometry while it is being edited.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafeNotReplicated
ShowHoverbooleanWhether a highlight is drawn over the object currently under the cursor.ReadSafeNotReplicated
ShowPivotIndicatorbooleanWhether to show the pivot indicator for a selected object as it's being dragged.ReadSafeNotReplicated
UseBoundingBoxesbooleanWhether draggers use axis-aligned bounding boxes rather than precise geometry for snapping calculations.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafeNotReplicated

AlignDraggedObjects: boolean#

NotReplicatedReadSafe

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.

AngleSnapEnabled: boolean#

NotReplicatedReadSafe

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.

AngleSnapIncrement: float#

NotReplicatedReadSafe

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.

AnimateHover: boolean#

NotReplicatedReadSafe

When true, the highlight drawn over the object under the cursor animates (pulses) at DraggerService.HoverAnimateFrequency. It only has a visible effect when DraggerService.ShowHover is true.

CollisionsEnabled: boolean#

NotReplicatedReadSafe

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.

DraggerCoordinateSpace: DraggerCoordinateSpace#

NotReplicatedReadSafe

Controls the coordinate space draggers operate in: DraggerCoordinateSpace.Object moves and rotates relative to the object's own orientation, while DraggerCoordinateSpace.World uses the global axes. Defaults to DraggerCoordinateSpace.Object.

DraggerMovementMode: DraggerMovementMode#

NotReplicatedReadSafe

Selects how draggers compute movement: DraggerMovementMode.Geometric applies transforms directly, while DraggerMovementMode.Physical respects physical constraints while dragging. Defaults to DraggerMovementMode.Geometric.

GeometrySnapColor: Color3#

NotReplicatedReadSafe

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.

HoverAnimateFrequency: float#

NotReplicatedReadSafe

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).

HoverThickness: float#

NotReplicatedReadSafe

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.

JointsEnabled: boolean#

NotReplicatedReadSafe

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.

LinearSnapEnabled: boolean#

NotReplicatedReadSafe

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.

LinearSnapIncrement: float#

NotReplicatedReadSafe

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.

PartSnapEnabled: boolean#

NotReplicatedRead: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe

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.

PivotSnapToGeometry: boolean#

NotReplicatedRead: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe

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.

ShowHover: boolean#

NotReplicatedReadSafe

When true, draggers draw a highlight over the object beneath the cursor to indicate what a drag would affect. When false, no hover highlight is shown and DraggerService.AnimateHover, DraggerService.HoverThickness, and DraggerService.HoverAnimateFrequency have no visible effect.

ShowPivotIndicator: boolean#

NotReplicatedReadSafe

When true, the pivot indicator (the marker showing an object's pivot point) is shown while dragging. Defaults to false.

UseBoundingBoxes: boolean#

NotReplicatedRead: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe

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.

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed