Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Handles

Places 3D handles around any object that its Adornee is set to.

Member index 12

HistoryMember
731Faces: Faces
731Style: HandlesStyle
462MouseButton1Down(face: NormalId)
462MouseButton1Up(face: NormalId)
462MouseDrag(face: NormalId, distance: float)
462MouseEnter(face: NormalId)
462MouseLeave(face: NormalId)
inherited from PartAdornment
731Adornee: BasePart
inherited from GuiBase3d
731Color3: Color3
731Transparency: float
731Visible: bool
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: 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
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

The Handles object places 3D handles around any object that its Adornee is set to; this property must be set to a 3D object for the handles to appear. The color can be changed and the shape of the handles can be set to either arrows or spheres.

For handles to be interactive, they must be parented to a player's PlayerGui or the CoreGui.

History 41

Members 12

Faces

TypeDefault
FacesRight, Top, Back, Left, Bottom, Front

Sets which sides the GUI handles will appear.

History 6

  • 731 Change Default of Faces from to Faces(Right, Top, Back, Left, Bottom, Front)
  • 726 Change Default of Faces from Faces(Right, Top, Back, Left, Bottom, Front) to
  • 553 Change Default of Faces from to Faces(Right, Top, Back, Left, Bottom, Front)
  • 486 Change ThreadSafety of Faces from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Faces from to ReadOnly
  • 47 Add Faces

MouseButton1Down

Parameters (1)
faceNormalId

Fired when the left mouse button goes down on one of the GUI handles.

History 2

MouseButton1Up

Parameters (1)
faceNormalId

Fired when the left mouse button is released on one of the GUI handles.

History 2

MouseDrag

Parameters (2)
faceNormalId
distancefloat

Fired when the mouse moves while the MouseButton1Down event has fired, but the left mouse button has not been released yet.

History 2

MouseEnter

Parameters (1)
faceNormalId

Fired when a mouse "enters" the GUI handle.

History 2

MouseLeave

Parameters (1)
faceNormalId

Fired when the mouse leaves the GUI handle.

History 2

Style

TypeDefault
HandlesStyleResize

Sets the GUI style of the handles. Currently there are only two types: Resize and Movement.

History 6

Settings