HandleAdornment
An abstract class inherited by 3D handle adornments.
| Memory category | Instances |
|---|
Member index 10
Description
History 30
- 687 Add
- 553 Change Default of ZIndex from to
- 553 Change Default of SizeRelativeOffset from to
- 553 Change Default of CFrame from to
- 553 Change Default of AlwaysOnTop from to
- 553 Change Default of AdornCullingMode from to
- 486 Change ThreadSafety of ZIndex from ReadOnly to ReadSafe
- 486 Change ThreadSafety of SizeRelativeOffset from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CFrame from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AlwaysOnTop from ReadOnly to ReadSafe
- 486 Change ThreadSafety of AdornCullingMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of MouseLeave from to Unsafe
- 462 Change ThreadSafety of MouseEnter from to Unsafe
- 462 Change ThreadSafety of MouseButton1Up from to Unsafe
- 462 Change ThreadSafety of MouseButton1Down from to Unsafe
- 462 Change ThreadSafety of ZIndex from to ReadOnly
- 462 Change ThreadSafety of SizeRelativeOffset from to ReadOnly
- 462 Change ThreadSafety of CFrame from to ReadOnly
- 462 Change ThreadSafety of AlwaysOnTop from to ReadOnly
- 462 Change ThreadSafety of AdornCullingMode from to ReadOnly
- 452 Add AdornCullingMode
- 196 Add MouseLeave
- 196 Add MouseEnter
- 196 Add MouseButton1Up
- 196 Add MouseButton1Down
- 196 Add ZIndex
- 196 Add SizeRelativeOffset
- 196 Add CFrame
- 196 Add AlwaysOnTop
- 196 Add HandleAdornment
Members 10
AdornCullingMode
| Type | Default | |
|---|---|---|
| AdornCullingMode | ||
This property determines whether to automatically cull the adornment based on distance from the camera.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of AdornCullingMode from to
- 486 Change ThreadSafety of AdornCullingMode from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AdornCullingMode from to ReadOnly
- 452 Add AdornCullingMode
AlwaysOnTop
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of AlwaysOnTop from to
- 486 Change ThreadSafety of AlwaysOnTop from ReadOnly to ReadSafe
- 462 Change ThreadSafety of AlwaysOnTop from to ReadOnly
- 196 Add AlwaysOnTop
CFrame
| Type | Default | |
|---|---|---|
| CFrame | ||
CFrame position and rotation relative to its PVAdornment.Adornee, applied after any translations due to SizeRelativeOffset.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
MouseButton1Down
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
This event fires when a player presses down their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of MouseButton1Down from to Unsafe
- 196 Add MouseButton1Down
MouseButton1Up
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
This event fires when a player releases their left mouse button while hovering over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of MouseButton1Up from to Unsafe
- 196 Add MouseButton1Up
MouseEnter
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
This event fires when a player moves their mouse over the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of MouseEnter from to Unsafe
- 196 Add MouseEnter
MouseLeave
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
This event fires when a player moves their mouse out of the adornment. Only fires if the adornment is parented to a player's PlayerGui or the CoreGui.
| Thread safety | Unsafe |
|---|
History 2
- 462 Change ThreadSafety of MouseLeave from to Unsafe
- 196 Add MouseLeave
SizeRelativeOffset
| Type | Default | |
|---|---|---|
| Vector3 | ||
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 Vector3.new(0, 1, 0) will shift the
adornment to the exact top of its adornee.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 553 Change Default of SizeRelativeOffset from to
- 486 Change ThreadSafety of SizeRelativeOffset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SizeRelativeOffset from to ReadOnly
- 196 Add SizeRelativeOffset
ZIndex
| Type | Default | |
|---|---|---|
| int | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |