# WireframeHandleAdornment

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [HandleAdornment](https://rapi.sleaze.dev/classes/HandleAdornment.md), [PVAdornment](https://rapi.sleaze.dev/classes/PVAdornment.md), [GuiBase3d](https://rapi.sleaze.dev/classes/GuiBase3d.md), [GuiBase](https://rapi.sleaze.dev/classes/GuiBase.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/WireframeHandleAdornment/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/WireframeHandleAdornment

Renders a wireframe adornment consisting of one or more lines onto a [`BasePart`](https://rapi.sleaze.dev/classes/BasePart.md) (including [`Terrain`](https://rapi.sleaze.dev/classes/Terrain.md)) or into the [`Workspace`](https://rapi.sleaze.dev/classes/Workspace.md).

## Properties

### Scale

```luau
WireframeHandleAdornment.Scale: Vector3 = Vector3.one
```

- Tags: Read capabilities: Basic + UI

The **XYZ** scale of the wireframe adornment.

### Thickness

```luau
WireframeHandleAdornment.Thickness: number = 1
```

- Tags: Read capabilities: Basic + UI

Thickness of the wireframe adornment's lines in pixels.

## Methods

### AddLine

```luau
WireframeHandleAdornment:AddLine(from: Vector3, to: Vector3)
```

- Tags: Capabilities: Basic + UI

Adds a line to the wireframe adornment from a starting point to an ending point relative to the center of the [`Adornee`](https://rapi.sleaze.dev/classes/PVAdornment.md).

Parameters:

- `from`: Starting point of the line.
- `to`: Ending point of the line.

### AddLines

```luau
WireframeHandleAdornment:AddLines(points: { any })
```

- Tags: Capabilities: Basic + UI

Adds one or more lines to the wireframe adornment using an array.

Parameters:

- `points`: Array of [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md) points in which each pair acts as a starting point and ending point for a line.

### AddPath

```luau
WireframeHandleAdornment:AddPath(points: { any }, loop: boolean)
```

- Tags: Capabilities: Basic + UI

Adds multiple line segments to the wireframe adornment in a sequence from point to point.

Parameters:

- `points`: Array of [`Vector3`](https://rapi.sleaze.dev/index/types/Vector3.md) points to connect in sequence with line segments.
- `loop`: Whether the path is closed by connecting its ending point to its starting point with an additional line.

### AddText

```luau
WireframeHandleAdornment:AddText(point: Vector3, text: string, size: number? = 12)
```

- Tags: Capabilities: Basic + UI

Adds a text label to the wireframe adornment.

Parameters:

- `point`: Position of the text in the adornment.
- `text`: String to display.
- `size`: Size of the text.

### Clear

```luau
WireframeHandleAdornment:Clear()
```

- Tags: Capabilities: Basic + UI

Instantly clears all lines and text in the wireframe adornment.

## Inherited members

- From [HandleAdornment](https://rapi.sleaze.dev/classes/HandleAdornment.md): `AdornCullingMode`, `AlwaysOnTop`, `CFrame`, `GizmoReference`, `SizeRelativeOffset`, `ZIndex`, `MouseButton1Down`, `MouseButton1Up`, `MouseEnter`, `MouseLeave`
- From [PVAdornment](https://rapi.sleaze.dev/classes/PVAdornment.md): `Adornee`
- From [GuiBase3d](https://rapi.sleaze.dev/classes/GuiBase3d.md): `Color3`, `Transparency`, `Color`, `Visible`
- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`