Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
WireframeHandleAdornment
Inherits from: HandleAdornment → PVAdornment → GuiBase3d → GuiBase → Instance → Object
WireframeHandleAdornment renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace. If parented to a player's PlayerGui or the CoreGui, this adornment can listen to input events for purposes such as making dragger tools.
Note that a WireframeHandleAdornment instance begins empty and you must add lines or paths to it through methods like AddLines() or AddPath().
The rendered wireframe can be customized visually through its Thickness, Color3, and Transparency properties, although these properties only affect subsequent draws and do not update lines already drawn into the adornment.
Inherits from: HandleAdornment
Memory category: Instances
Code samples: View on Creator Hub (WireframeHandleAdornment-Basic-Path, WireframeHandleAdornment-Multicolor).
Properties
| Name | Type / Returns | Description |
|---|---|---|
| WireframeHandleAdornment.Scale | Vector3 | The XYZ scale of the wireframe adornment. |
| WireframeHandleAdornment.Thickness | float | Thickness of the wireframe adornment's lines in pixels. |
Inherited from HandleAdornment
| 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 |
WireframeHandleAdornment.Scale
This property specifies the XYZ scale of the wireframe adornment as a Vector3. For example, a scale of Vector3.new(1, 2, 1) will scale the adornment twice its normal size on the Y axis while keeping the X and Z axes unchanged.
| Field | Value |
|---|---|
| type | Vector3 |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
WireframeHandleAdornment.Thickness
This property determines the thickness of the wireframe adornment's lines in pixels. Note that this visual thickness does not change relative to the adornment's distance from the viewer's camera.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | Data |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Basic","UI"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| WireframeHandleAdornment:AddLine | () | Adds a line to the wireframe adornment from a starting point to an ending point relative to the center of the Adornee. |
| WireframeHandleAdornment:AddLines | () | Adds one or more lines to the wireframe adornment using an array. |
| WireframeHandleAdornment:AddPath | () | Adds multiple line segments to the wireframe adornment in a sequence from point to point. |
| WireframeHandleAdornment:AddText | () | Adds a text label to the wireframe adornment. |
| WireframeHandleAdornment:Clear | () | Instantly clears all lines and text in the wireframe adornment. |
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 |
WireframeHandleAdornment:AddLine
This method adds a line to the wireframe adornment from a starting point to an ending point, both defined as a Vector3 relative to the center of the Adornee.
Note that you can make a multicolor wireframe by changing the adornment's Color3 property before new lines are drawn via AddLine(), as demonstrated in the following code sample.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| from | Vector3 | Starting point of the line. | |
| to | Vector3 | Ending point of the line. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic","UI"] |
Code samples: View on Creator Hub (WireframeHandleAdornment-Multicolor).
WireframeHandleAdornment:AddLines
This method adds one or more lines of the current Color3 color to the wireframe adornment using an array. Each pair of Vector3 points in the array acts as a starting point and ending point for a line, relative to the center of the Adornee.
Note that lines are rendered independently and their ending points are not connected to the starting point of any other line. To connect multiple line segments in a sequence from point to point, see AddPath().
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| points | Array | Array of Vector3 points in which each pair acts as a starting point and ending point for a line. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic","UI"] |
Code samples: View on Creator Hub (WireframeHandleAdornment-Lines-Array).
WireframeHandleAdornment:AddPath
This method adds multiple line segments of the current Color3 color to the wireframe adornment in a sequence from point to point. The path can be closed (ending point connected to starting point) by setting the loop parameter to true.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| points | Array | Array of Vector3 points to connect in sequence with line segments. | |
| loop | boolean | Whether the path is closed by connecting its ending point to its starting point with an additional line. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic","UI"] |
Code samples: View on Creator Hub (WireframeHandleAdornment-Basic-Path).
WireframeHandleAdornment:AddText
Adds a text label to the wireframe adornment at a Vector3 point relative to the center of the Adornee. You can adjust the size of the text through the size parameter, and the label renders in the current Color3 color.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| point | Vector3 | Position of the text in the adornment. | |
| text | string | String to display. | |
| size | int | 12 | Size of the text. |
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic","UI"] |
WireframeHandleAdornment:Clear
Instantly clears all lines and text in the wireframe adornment.
Returns
| Type | Description |
|---|---|
| () |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Basic","UI"] |
Events
Inherited from HandleAdornment
| 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. |