Reference API Roblox

Engine API

Website

Related

Reference API Roblox

WireframeHandleAdornment

Renders a wireframe adornment consisting of one or more lines onto a BasePart (including Terrain) or into the Workspace.

Member index 7

HistoryMember
565Scale: Vector3
670Thickness: float
573AddLine(from: Vector3, to: Vector3): null
573AddLines(points: Array): null
573AddPath(points: Array, loop: bool): null
613AddText(point: Vector3, text: string, size: int = 12): null
573Clear(): null
inherited from HandleAdornment
553AdornCullingMode: AdornCullingMode
553AlwaysOnTop: bool
553CFrame: CFrame
553SizeRelativeOffset: Vector3
553ZIndex: int
462MouseButton1Down()
462MouseButton1Up()
462MouseEnter()
462MouseLeave()
inherited from PVAdornment
553Adornee: PVInstance
inherited from GuiBase3d
553Color3: Color3
553Transparency: float
553Visible: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
691GetPredictionMode(): PredictionMode
641GetStyled(name: string): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
690IsPredicted(): bool
664IsPropertyModified(property: string): bool
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
690SetPredictionMode(mode: PredictionMode): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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

Members 7

AddLine

Parameters (2)
fromVector3
toVector3
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.

History 2

AddLines

Parameters (1)
pointsArray
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().

History 2

AddPath

Parameters (2)
pointsArray
loopbool
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.

History 2

AddText

Parameters (3)Default
pointVector3
textstring
sizeint12
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.

History 1

Clear

Parameters (0)
No parameters.
Returns (1)
null

Instantly clears all lines and text in the wireframe adornment.

History 2

Scale

TypeDefault
Vector31, 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.

History 1

Thickness

TypeDefault
float1

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.

History 1

Settings