WireframeHandleAdornment¶
Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
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.
Inheritance¶
Object → Instance → GuiBase → GuiBase3d → PVAdornment → HandleAdornment → WireframeHandleAdornment
Properties¶
| Member | Signature | Summary |
|---|---|---|
Scale |
Scale: Vector3 |
The XYZ scale of the wireframe adornment. |
Thickness |
Thickness: float |
Thickness of the wireframe adornment's lines in pixels. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
AddLine |
WireframeHandleAdornment:AddLine(from: Vector3, to: Vector3): null |
Adds a line to the wireframe adornment from a starting point to an ending point relative to the center of the Adornee. |
AddLines |
WireframeHandleAdornment:AddLines(points: Array): null |
Adds one or more lines to the wireframe adornment using an array. |
AddPath |
WireframeHandleAdornment:AddPath(points: Array, loop: bool): null |
Adds multiple line segments to the wireframe adornment in a sequence from point to point. |
AddText |
WireframeHandleAdornment:AddText(point: Vector3, text: string, size: int = 12): null |
Adds a text label to the wireframe adornment. |
Clear |
WireframeHandleAdornment:Clear(): null |
Instantly clears all lines and text in the wireframe adornment. |
Roblox reference: WireframeHandleAdornment
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.