Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
HandleAdornment
Inherits from: PVAdornment → GuiBase3d → GuiBase → Instance → Object
HandleAdornment is an abstract class inherited by 3D handle adornments. If parented to a player's PlayerGui or the CoreGui, handles can listen to input events for purposes such as making dragger tools.
Inherits from: PVAdornment
Descendants: BoxHandleAdornment, ConeHandleAdornment, CylinderHandleAdornment, ImageHandleAdornment, LineHandleAdornment, PyramidHandleAdornment, SphereHandleAdornment, WireframeHandleAdornment
Memory category: Instances
Tags: NotCreatable
Properties
| Name | Type / Returns | Description |
|---|---|---|
| HandleAdornment.AdornCullingMode | AdornCullingMode | Determines whether to automatically cull the adornment. |
| HandleAdornment.AlwaysOnTop | boolean | Forces this adornment to render on top of all 3D objects in the workspace. |
| HandleAdornment.CFrame | CFrame | The position and rotation of the object relative to its PVAdornment.Adornee. |
| HandleAdornment.SizeRelativeOffset | Vector3 | The positional offset of the adornment based on the adornee's BasePart.Size. |
| HandleAdornment.ZIndex | int | Determines the draw order of this HandleAdornment when AlwaysOnTop is true. |
Inherited from PVAdornment
| Name | Type / Returns | Description |
|---|---|---|
| PVAdornment.Adornee | PVInstance | The PVInstance which this PVAdornment is attached 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 |
HandleAdornment.AdornCullingMode
This property determines whether to automatically cull the adornment based on distance from the camera.
| Field | Value |
|---|---|
| type | AdornCullingMode |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
HandleAdornment.AlwaysOnTop
If true, forces this adornment to render on top of all 3D objects in the workspace. As an exception, setting ZIndex to -1 will override an AlwaysOnTop value of true and cause the adornment to appear either in front of or behind other adornments and objects based on their relative position in the 3D space.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
HandleAdornment.CFrame
CFrame position and rotation relative to its PVAdornment.Adornee, applied after any translations due to SizeRelativeOffset.
| Field | Value |
|---|---|
| type | CFrame |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
HandleAdornment.SizeRelativeOffset
By default, an adornment draws in the center of its Adornee, but this property shifts the adornment's relative position based on the adornee's BasePart.Size.
Note that the units of SizeRelativeOffset are a scale based on the size of the adornee itself, such that a value of 1 will move the adornment to the corresponding edge of the adornee. For example, a value of Vector3.new(0, 1, 0) will shift the adornment to the exact top of its adornee.
| Field | Value |
|---|---|
| type | Vector3 |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
HandleAdornment.ZIndex
Only applies if AlwaysOnTop is true and determines the draw order of this HandleAdornment relative to other adornments. It does not relate to the ZIndex property for GuiObjects.
Valid values are from -1 to 10 with higher values drawing on top (in front) of lesser values. This drawing order will be respected even if an adornment is in front of or behind another adornment in the 3D space.
As an exception, setting ZIndex to -1 or AlwaysOnTop to false will cause the adornment to appear either in front of or behind other adornments and objects based on their relative position in the 3D space.
| Field | Value |
|---|---|
| type | int |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| HandleAdornment.MouseButton1Down | Fires when a player presses down on their left mouse button while hovering over the adornment. | |
| HandleAdornment.MouseButton1Up | Fires when a player releases their left mouse button while hovering over the adornment. | |
| HandleAdornment.MouseEnter | Fires when a player moves their mouse over the adornment. | |
| HandleAdornment.MouseLeave | Fires when a player moves their mouse out of the adornment. |
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. |
HandleAdornment.MouseButton1Down
This event fires when a player presses down their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI"] |
HandleAdornment.MouseButton1Up
This event fires when a player releases their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI"] |
HandleAdornment.MouseEnter
This event fires when a player moves their mouse over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI"] |
HandleAdornment.MouseLeave
This event fires when a player moves their mouse out of the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Basic","UI"] |
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 |