BoxHandleAdornment

Show Deprecated

For handles to be interactive, they must be parented to a player's PlayerGui or the CoreGui.

The BoxHandleAdornment is a rectangular prism that can be adorned to a BasePart. This adornment can listen to input events and is commonly used to make dragger tools.

Summary

Properties

Size:Vector3
Read Parallel
The size of the adornment.

Properties inherited from HandleAdornment

AdornCullingMode:Enum.AdornCullingMode
Read Parallel
Determines whether to automatically cull the adornment.
AlwaysOnTop:boolean
Read Parallel
Forces this object to render on top of all 3D objects in the workspace.
CFrame:CFrame
Read Parallel
The position and rotation of the object relative to its PVAdornment.Adornee.
SizeRelativeOffset:Vector3
Read Parallel
The positional offset of the adornment based on the adornee's BasePart.Size.
ZIndex:number
Read Parallel
Determines the draw order of the HandleAdornment.

Properties inherited from PVAdornment

Adornee:PVInstance
Read Parallel
The PVInstance the PVAdornment is attached to.

Properties inherited from GuiBase3d

Color3:Color3
Read Parallel
Sets the color of a GUI object.
Transparency:number
Read Parallel
Sets the transparency of a GUI object, where 1 is invisible and 0 is completely visible.
Visible:boolean
Read Parallel
Determines whether the object and its descendants will be displayed.

View all inherited from Instance

View all inherited from Object

Methods

View all inherited from Instance

View all inherited from Object

Events

Events inherited from HandleAdornment

MouseButton1Down():RBXScriptSignal
Fires when a user presses down on their left mouse button while hovering over the adornment.
MouseButton1Up():RBXScriptSignal
Fires when a user releases their left mouse button while hovering over the adornment.
MouseEnter():RBXScriptSignal
Fires when a user moves their mouse over the adornment.
MouseLeave():RBXScriptSignal
Fires when a user moves their mouse out of the adornment.