Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Dragger

A helper object used to create tools that can drag parts.

Member index 4

HistoryMember
573AxisRotate(axis: Axis = X): null
648MouseDown(mousePart: Instance, pointOnMousePart: Vector3, parts: Instances): null
573MouseMove(mouseRay: Ray): null
573MouseUp(): null
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

The Dragger object is a helper object used to create tools that can drag parts. It is expected (but not required) to be used with Mouse events.

Its implementation is primarily used in the RbxStamper library.

History 16

Members 4

AxisRotate

Parameters (1)Default
axisAxisX
Returns (1)
null

Rotates the currently dragged part(s) by 90 degrees on the given axis.

History 3

MouseDown

Parameters (3)
mousePartInstance
pointOnMousePartVector3
partsInstances
Returns (1)
null

Initializes a dragging action, specifying which parts to use when dragging.

History 5

MouseMove

Parameters (1)
mouseRayRay
Returns (1)
null

Tries to move the currently dragged part to the point where MouseRay hits another part.

History 4

MouseUp

Parameters (0)
No parameters.
Returns (1)
null

Stops the current dragging action (made by Dragger:MouseDown())

History 3

Settings