--- name: HandleAdornment last_updated: 2026-06-10T02:17:46Z inherits: - PVAdornment - GuiBase3d - GuiBase - Instance - Object type: class memory_category: Instances tags: - NotCreatable summary: "An abstract class inherited by 3D handle adornments." --- # Class: HandleAdornment > An abstract class inherited by 3D handle adornments. ## Description `HandleAdornment` is an abstract class inherited by 3D handle adornments. If parented to a player's [PlayerGui](/docs/reference/engine/classes/PlayerGui.md) or the [CoreGui](/docs/reference/engine/classes/CoreGui.md), handles can listen to input events for purposes such as making dragger tools. ## Properties ### Property: HandleAdornment.AdornCullingMode ```json { "type": "AdornCullingMode", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "Data", "capabilities": [ "Basic", "UI" ] } ``` This property determines whether to automatically cull the adornment based on distance from the camera. ### Property: HandleAdornment.AlwaysOnTop ```json { "type": "boolean", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "Data", "capabilities": [ "Basic", "UI" ] } ``` If `true`, forces this adornment to render on top of all 3D objects in the workspace. As an exception, setting [ZIndex](/docs/reference/engine/classes/HandleAdornment.md) to `-1` will override an [AlwaysOnTop](/docs/reference/engine/classes/HandleAdornment.md) 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. ### Property: HandleAdornment.CFrame ```json { "type": "CFrame", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "Data", "capabilities": [ "Basic", "UI" ] } ``` [CFrame](/docs/reference/engine/datatypes/CFrame.md) position and rotation relative to its [PVAdornment.Adornee](/docs/reference/engine/classes/PVAdornment.md), applied after any translations due to [SizeRelativeOffset](/docs/reference/engine/classes/HandleAdornment.md). ### Property: HandleAdornment.SizeRelativeOffset ```json { "type": "Vector3", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "Data", "capabilities": [ "Basic", "UI" ] } ``` By default, an adornment draws in the center of its [Adornee](/docs/reference/engine/classes/HandleAdornment.md), but this property shifts the adornment's relative position based on the adornee's [BasePart.Size](/docs/reference/engine/classes/BasePart.md). Note that the units of [SizeRelativeOffset](/docs/reference/engine/classes/HandleAdornment.md) 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)](/docs/reference/engine/datatypes/Vector3.md) will shift the adornment to the exact top of its adornee. ### Property: HandleAdornment.ZIndex ```json { "type": "int", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "Data", "capabilities": [ "Basic", "UI" ] } ``` Only applies if [AlwaysOnTop](/docs/reference/engine/classes/HandleAdornment.md) is `true` and determines the draw order of this [HandleAdornment](/docs/reference/engine/classes/HandleAdornment.md) relative to other adornments. It does not relate to the [ZIndex](/docs/reference/engine/classes/GuiObject.md) property for [GuiObjects](/docs/reference/engine/classes/GuiObject.md). 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](/docs/reference/engine/classes/HandleAdornment.md) to `-1` or [AlwaysOnTop](/docs/reference/engine/classes/HandleAdornment.md) 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. ## Events ### Event: HandleAdornment.MouseButton1Down **Signature:** `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](/docs/reference/engine/classes/PlayerGui.md) or the [CoreGui](/docs/reference/engine/classes/CoreGui.md). *Security: None · Capabilities: Basic, UI* ### Event: HandleAdornment.MouseButton1Up **Signature:** `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](/docs/reference/engine/classes/PlayerGui.md) or the [CoreGui](/docs/reference/engine/classes/CoreGui.md). *Security: None · Capabilities: Basic, UI* ### Event: HandleAdornment.MouseEnter **Signature:** `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](/docs/reference/engine/classes/PlayerGui.md) or the [CoreGui](/docs/reference/engine/classes/CoreGui.md). *Security: None · Capabilities: Basic, UI* ### Event: HandleAdornment.MouseLeave **Signature:** `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](/docs/reference/engine/classes/PlayerGui.md) or the [CoreGui](/docs/reference/engine/classes/CoreGui.md). *Security: None · Capabilities: Basic, UI* ## Inherited Members ### From [PVAdornment](/docs/reference/engine/classes/PVAdornment.md) - **Property `Adornee`** (`PVInstance`): The PVInstance which this PVAdornment is attached to. ### From [GuiBase3d](/docs/reference/engine/classes/GuiBase3d.md) - **Property `Color`** (`BrickColor`): Sets the color of a GUI object. *(deprecated, hidden)* - **Property `Color3`** (`Color3`): Sets the color of this GuiBase3d object. - **Property `Transparency`** (`float`): Sets the transparency of this GuiBase3d object. - **Property `Visible`** (`boolean`): Determines whether this GuiBase3d object and its descendants will ### From [Instance](/docs/reference/engine/classes/Instance.md) - **Property `Archivable`** (`boolean`): Determines if an Instance and its descendants can be cloned using - **Property `archivable`** (`boolean`): *(deprecated, hidden)* - **Property `Capabilities`** (`SecurityCapabilities`): The set of capabilities allowed to be used for scripts inside this - **Property `Name`** (`string`): A non-unique identifier of the Instance. - **Property `Parent`** (`Instance`): Determines the hierarchical parent of the Instance. - **Property `PredictionMode`** (`PredictionMode`): - **Property `RobloxLocked`** (`boolean`): A deprecated property that used to protect CoreGui objects. *(hidden)* - **Property `Sandboxed`** (`boolean`): When enabled, the instance can only access abilities in its `Capabilities` - **Property `UniqueId`** (`UniqueId`): A unique identifier for the instance. - **Method `AddTag(tag: string): ()`**: Applies a tag to the instance. - **Method `children(): Instances`**: Returns an array of the object's children. *(deprecated)* - **Method `ClearAllChildren(): ()`**: This method destroys all of an instance's children. - **Method `Clone(): Instance`**: Create a copy of an instance and all its descendants, ignoring instances - **Method `clone(): Instance`**: *(deprecated)* - **Method `Destroy(): ()`**: Sets the Instance.Parent property to `nil`, locks the - **Method `destroy(): ()`**: *(deprecated)* - **Method `FindFirstAncestor(name: string): Instance?`**: Returns the first ancestor of the Instance whose - **Method `FindFirstAncestorOfClass(className: string): Instance?`**: Returns the first ancestor of the Instance whose - **Method `FindFirstAncestorWhichIsA(className: string): Instance?`**: Returns the first ancestor of the Instance for whom - **Method `FindFirstChild(name: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance found with the given name. - **Method `findFirstChild(name: string, recursive?: boolean): Instance`**: *(deprecated)* - **Method `FindFirstChildOfClass(className: string): Instance?`**: Returns the first child of the Instance whose - **Method `FindFirstChildWhichIsA(className: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance for whom - **Method `FindFirstDescendant(name: string): Instance?`**: Returns the first descendant found with the given Instance.Name. - **Method `GetActor(): Actor?`**: Returns the Actor associated with the Instance, if any. - **Method `GetAttribute(attribute: string): Variant`**: Returns the value which has been assigned to the given attribute name. - **Method `GetAttributeChangedSignal(attribute: string): RBXScriptSignal`**: Returns an event that fires when the given attribute changes. - **Method `GetAttributes(): Dictionary`**: Returns a dictionary of the instance's attributes. - **Method `GetChildren(): Instances`**: Returns an array containing all of the instance's children. - **Method `getChildren(): Instances`**: *(deprecated)* - **Method `GetDebugId(scopeLength?: int): string`**: Returns a coded string of the debug ID used internally by Roblox. - **Method `GetDescendants(): Instances`**: Returns an array containing all of the descendants of the instance. - **Method `GetFullName(): string`**: Returns a string describing the instance's ancestry. - **Method `GetStyled(name: string, selector: string?): Variant`**: Returns the styled or explicitly modified value of the specified property, - **Method `GetStyledPropertyChangedSignal(property: string): RBXScriptSignal`**: - **Method `GetTags(): Array`**: Gets an array of all tags applied to the instance. - **Method `HasTag(tag: string): boolean`**: Check whether the instance has a given tag. - **Method `IsAncestorOf(descendant: Instance): boolean`**: Returns true if an Instance is an ancestor of the given - **Method `IsDescendantOf(ancestor: Instance): boolean`**: Returns `true` if an Instance is a descendant of the given - **Method `isDescendantOf(ancestor: Instance): boolean`**: *(deprecated)* - **Method `IsPropertyModified(property: string): boolean`**: Returns `true` if the value stored in the specified property is not equal - **Method `QueryDescendants(selector: string): Instances`**: - **Method `Remove(): ()`**: Sets the object's `Parent` to `nil`, and does the same for all its *(deprecated)* - **Method `remove(): ()`**: *(deprecated)* - **Method `RemoveTag(tag: string): ()`**: Removes a tag from the instance. - **Method `ResetPropertyToDefault(property: string): ()`**: Resets a property to its default value. - **Method `SetAttribute(attribute: string, value: Variant): ()`**: Sets the attribute with the given name to the given value. - **Method `WaitForChild(childName: string, timeOut: double): Instance`**: Returns the child of the Instance with the given name. If the - **Event `AncestryChanged`**: Fires when the Instance.Parent property of this object or one of - **Event `AttributeChanged`**: Fires whenever an attribute is changed on the Instance. - **Event `ChildAdded`**: Fires after an object is parented to this Instance. - **Event `childAdded`**: *(deprecated)* - **Event `ChildRemoved`**: Fires after a child is removed from this Instance. - **Event `DescendantAdded`**: Fires after a descendant is added to the Instance. - **Event `DescendantRemoving`**: Fires immediately before a descendant of the Instance is removed. - **Event `Destroying`**: Fires immediately before (or is deferred until after) the instance is - **Event `StyledPropertiesChanged`**: Fires whenever any style property is changed on the instance, including ### From [Object](/docs/reference/engine/classes/Object.md) - **Property `ClassName`** (`string`): A read-only string representing the class this Object belongs to. - **Property `className`** (`string`): *(deprecated)* - **Method `GetPropertyChangedSignal(property: string): RBXScriptSignal`**: Get an event that fires when a given property of the object changes. - **Method `IsA(className: string): boolean`**: Returns true if an object's class matches or inherits from a given class. - **Method `isA(className: string): boolean`**: *(deprecated)* - **Event `Changed`**: Fires immediately after a property of the object changes, with some