HandleAdornment¶
An abstract class inherited by 3D handle adornments.
Description¶
HandleAdornment is an abstract class inherited by 3D handle adornments. If
parented to a player's PlayerGui or the CoreGui, handles can
listen to input events for purposes such as making dragger tools.
Inheritance¶
Object → Instance → GuiBase → GuiBase3d → PVAdornment → HandleAdornment
Nova inheritance: Instance → GuiBase → GuiBase3d → PVAdornment → HandleAdornment
Known subclasses: BoxHandleAdornment, ConeHandleAdornment, CylinderHandleAdornment, ImageHandleAdornment, LineHandleAdornment, PyramidHandleAdornment, SphereHandleAdornment, WireframeHandleAdornment
Properties¶
AlwaysOnTop Supported Property Forces this adornment to render on top of all 3D objects in the workspace.
If true, forces this adornment to render on top of all 3D objects in the
workspace. As an exception, setting ZIndex
to -1 will override an AlwaysOnTop
value of true and cause the adornment to appear either in front of or
behind other adornments and objects based on their relative position in
the 3D space.
CFrame Supported Property The position and rotation of the object relative to its PVAdornment.Adornee.
The position and rotation of the object relative to its PVAdornment.Adornee.
CFrame position and rotation relative to its PVAdornment.Adornee, applied after any translations due to SizeRelativeOffset.
SizeRelativeOffset Supported Property The positional offset of the adornment based on the adornee's BasePart.Size.
The positional offset of the adornment based on the adornee's BasePart.Size.
By default, an adornment draws in the center of its Adornee, but this property shifts the adornment's relative position based on the adornee's BasePart.Size.
Note that the units of
SizeRelativeOffset are a
scale based on the size of the adornee itself, such that a value of
1 will move the adornment to the corresponding edge of the adornee. For
example, a value of Datatype.Vector3.new(0, 1, 0) will shift the
adornment to the exact top of its adornee.
ZIndex Supported Property Determines the draw order of this HandleAdornment when AlwaysOnTop is true.
Determines the draw order of this HandleAdornment when
AlwaysOnTop is true.
Only applies if AlwaysOnTop is true
and determines the draw order of this HandleAdornment relative to
other adornments. It does not relate to the
ZIndex property for GuiObjects.
Valid values are from -1 to 10 with higher values drawing on top (in
front) of lesser values. This drawing order will be respected even if an
adornment is in front of or behind another adornment in the 3D space.
As an exception, setting ZIndex to -1 or
AlwaysOnTop to false will cause the
adornment to appear either in front of or behind other adornments and
objects based on their relative position in the 3D space.
Events¶
MouseButton1Down Supported Event Fires when a player presses down on their left mouse button while hovering over the adornment.
MouseButton1Up Supported Event Fires when a player releases their left mouse button while hovering over the adornment.
MouseEnter Supported Event Fires when a player moves their mouse over the adornment.
MouseLeave Supported Event Fires when a player moves their mouse out of the adornment.
Inherited members¶
Inherited from PVAdornment: 13 properties, 36 methods, 7 events. They are documented on the base class page.
1 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's HandleAdornment class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
AdornCullingMode |
AdornCullingMode: AdornCullingMode |
Not yet | Determines whether to automatically cull the adornment. | — |
Roblox reference: HandleAdornment
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.