HandleAdornment

This property determines whether to automatically cull the adornment based on distance from the camera.

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 position and rotation relative to its PVAdornment.Adornee, applied after any translations due to SizeRelativeOffset.

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.

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.

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.

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.

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.

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.