Skip to content
Roblox API Reference

DraggerService

A service that centralizes the global dragger settings that Studio's dragging tools read so they move, snap, and highlight objects consistently.
  • Not creatable
  • Not replicated
  • Service
Memory category
Instances
Own members
19
Inherited members
75
Subclasses
0
Siblings
608

Properties42

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Defined byDraggerService19

Property categoryData

  • DraggerService.AlignDraggedObjects: boolean
    Whether a dragged object is re-aligned to the surface it is dropped onto.
    • Not replicated
  • DraggerService.AngleSnapEnabled: boolean
    Whether rotation drags snap to multiples of DraggerService.AngleSnapIncrement.
    • Not replicated
  • DraggerService.AngleSnapIncrement: number
    The angle, in degrees, that rotation drags snap to.
    • Not replicated
  • DraggerService.AnimateHover: boolean
    Whether the hover highlight pulses instead of staying static.
    • Not replicated
  • DraggerService.CollisionsEnabled: boolean
    Whether draggers prevent a moved object from overlapping other geometry.
    • Not replicated
  • DraggerService.DraggerCoordinateSpace: Enum.DraggerCoordinateSpace
    Whether drag transforms are applied in the object's local space or in world space.
    • Not replicated
  • DraggerService.DraggerMovementMode: Enum.DraggerMovementMode
    Whether dragging moves objects geometrically or by respecting physical constraints.
    • Not replicated
  • DraggerService.GeometrySnapColor: Color3
    The color of the on-screen indicators drawn when a drag snaps to geometry.
    • Not replicated
  • DraggerService.HoverAnimateFrequency: number
    The frequency, in hertz, at which the hover highlight animates.
    • Not replicated
  • DraggerService.HoverLineThickness: number
    • Hidden
    • Roblox script security
  • DraggerService.HoverThickness: number
    The thickness of the highlight outline drawn around the object under the cursor.
    • Not replicated
  • DraggerService.JointsEnabled: boolean
    Whether draggers create surface joints between touching parts when a drag ends.
    • Not replicated
  • DraggerService.LinearSnapEnabled: boolean
    Whether positional drags snap to a grid of DraggerService.LinearSnapIncrement.
    • Not replicated
  • DraggerService.LinearSnapIncrement: number
    The grid size, in studs, that positional drags snap to.
    • Not replicated
  • DraggerService.PartSnapEnabled: boolean
    Whether draggers snap to alignment points on nearby parts.
    • Not replicated
    • Roblox script security
  • DraggerService.PivotSnapToGeometry: boolean
    Whether an object's pivot snaps to points on nearby geometry while it is being edited.
    • Not replicated
    • Roblox script security
  • DraggerService.ShowHover: boolean
    Whether a highlight is drawn over the object currently under the cursor.
    • Not replicated
  • DraggerService.ShowPivotIndicator: boolean
    Whether to show the pivot indicator for a selected object as it's being dragged.
    • Not replicated
  • DraggerService.UseBoundingBoxes: boolean
    Whether draggers use axis-aligned bounding boxes rather than precise geometry for snapping calculations.
    • Not replicated
    • Roblox script security

Methods42

Inherited fromObject3
  • Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39

Events10

Inherited fromObject1
Inherited fromInstance9