Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
Handles
Inherits from: HandlesBase → PartAdornment → GuiBase3d → GuiBase → Instance → Object
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.
Inherits from: HandlesBase
Memory category: Instances
Properties
| Name | Type / Returns | Description |
|---|---|---|
| Handles.Faces | Faces | Sets which sides the GUI handles will appear. |
| Handles.Style | HandlesStyle | Sets the GUI style of the handles. |
Inherited from PartAdornment
| Name | Type / Returns | Description |
|---|---|---|
| PartAdornment.Adornee | BasePart | Sets the object to adorn to. |
Inherited from GuiBase3d
| Name | Type / Returns | Description |
|---|---|---|
| GuiBase3d.Color | BrickColor | Sets the color of a GUI object. |
| GuiBase3d.Color3 | Color3 | Sets the color of this GuiBase3d object. |
| GuiBase3d.Transparency | float | Sets the transparency of this GuiBase3d object. |
| GuiBase3d.Visible | boolean | Determines whether this GuiBase3d object and its descendants will be displayed. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Handles.Faces
Sets which sides the GUI handles will appear.
| Field | Value |
|---|---|
| type | Faces |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI","Input"] |
Handles.Style
Sets the GUI style of the handles. Currently there are only two types: Resize and Movement.
| Field | Value |
|---|---|
| type | HandlesStyle |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Appearance |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI","Input"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| Handles.MouseButton1Down | Fired when the left mouse button goes down on one of the GUI handles. | |
| Handles.MouseButton1Up | Fired when the left mouse button is released on one of the GUI handles. | |
| Handles.MouseDrag | Fired when the mouse moves while the MouseButton1Down event has fired, but the left mouse button has not been released yet. | |
| Handles.MouseEnter | Fired when a mouse "enters" the GUI handle. | |
| Handles.MouseLeave | Fired when the mouse leaves the GUI handle. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
Handles.MouseButton1Down
Fired when the left mouse button goes down on one of the GUI handles.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| face | NormalId | The NormalId of the face whose handle was pressed. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI","Input"] |
Handles.MouseButton1Up
Fired when the left mouse button is released on one of the GUI handles.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| face | NormalId | The NormalId of the face whose handle was pressed when the interaction began. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI","Input"] |
Handles.MouseDrag
Fired when the mouse moves while the MouseButton1Down event has fired, but the left mouse button has not been released yet.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| face | NormalId | The NormalId of the face whose handle is being dragged. | |
| distance | float | The signed distance, in studs, that the mouse has been dragged along the handle's axis since Handles.MouseButton1Down fired. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI","Input"] |
Handles.MouseEnter
Fired when a mouse "enters" the GUI handle.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| face | NormalId | The NormalId of the face whose handle the mouse moved onto. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI","Input"] |
Handles.MouseLeave
Fired when the mouse leaves the GUI handle.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| face | NormalId | The NormalId of the face whose handle the mouse moved off of. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI","Input"] |
Methods
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |