WireframeHandleAdornment
Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace.
| Memory category | Instances |
|---|
Member index 7
Description
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.
History 13
- 670 Add Thickness
- 613 Add AddText
- 573 Change ReturnType of Clear from void to null
- 573 Change ReturnType of AddPath from void to null
- 573 Change ReturnType of AddLines from void to null
- 573 Change ReturnType of AddLine from void to null
- 565 Add Scale
- 547 Change Tags of WireframeHandleAdornment from [NotBrowsable] to []
- 538 Add Clear
- 538 Add AddPath
- 538 Add AddLines
- 538 Add AddLine
- 538 Add WireframeHandleAdornment
Members 7
AddLine
| Parameters (2) | ||
|---|---|---|
| from | Vector3 | |
| to | Vector3 | |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
AddLines
| Parameters (1) | ||
|---|---|---|
| points | Array | |
| Returns (1) | ||
| null | ||
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().
| Thread safety | Unsafe |
|---|
AddPath
| Parameters (2) | ||
|---|---|---|
| points | Array | |
| loop | bool | |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
AddText
| Parameters (3) | Default | |
|---|---|---|
| point | Vector3 | |
| text | string | |
| size | int | 12 |
| Returns (1) | ||
| null | ||
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.
| Thread safety | Unsafe |
|---|
Clear
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
Instantly clears all lines and text in the wireframe adornment.
| Thread safety | Unsafe |
|---|
Scale
| Type | Default | |
|---|---|---|
| Vector3 | 1, 1, 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
Thickness
| Type | Default | |
|---|---|---|
| float | 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |