Class
BoxHandleAdornment
A box-shaped handle that can be adorned to a BasePart.
BoxHandleAdornment is a box-shaped handle that can be adorned to a
BasePart. If parented to a player's PlayerGui or the
CoreGui, handles can listen to input events for purposes such as
making dragger tools.
Properties 2#
ShadingAdornShading | Determines how the box adornment is shaded and whether it draws through geometry that would otherwise occlude it.ReadSafe |
SizeVector3 | Size of the adornment.ReadSafe |
Shading: AdornShading#
ReadSafe
Shading selects the material and render pass used to draw the box, using
a value of the AdornShading enum. It defaults to
Default, which draws the box unlit and occluded by
scene geometry like an ordinary world object.
Shaded and XRayShaded light the
box with the scene's lighting instead of drawing it unlit, while
XRay and XRayShaded draw the box
through geometry that would otherwise occlude it.
AlwaysOnTop draws the box on top of everything else
with no depth testing.
The legacy HandleAdornment.AlwaysOnTop property only takes effect
while Shading is Default; any other Shading value
determines the render pass on its own.
Size: Vector3#
ReadSafe
The size of the adornment in studs.
Inherited members#
Inherited from HandleAdornment 9
Properties (5)
AdornCullingMode, AlwaysOnTop, CFrame, SizeRelativeOffset, ZIndex
Events (4)
Inherited from PVAdornment 1
Properties (1)
Inherited from GuiBase3d 4
Properties (4)
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild