Fill

Fill : OverlayBase

Overview

Properties

Color

Color3

Defines the fill color of the overlay using a Color3 value. This property determines the visible hue and shade applied to the rendered fill area.

Code Samples

Transparency

number

Controls how opaque or see-through the fill appears. A value of 0 means fully opaque, while 1 makes the fill completely transparent.

Code Samples

DepthMode

Enum.FillDepthModeType

Specifies how the fill is rendered relative to other 3D objects in the scene, using one of the modes defined in the FillDepthModeType enum:

• AlwaysOnTop: The fill is always rendered above all other geometry, regardless of occlusion or depth.

• VisibleWhenNotOccluded: The fill is rendered only when it is not blocked by other objects in the scene.

• VisibleWhenOccluded: The fill is rendered only when it is occluded—that is, it appears only when hidden behind other objects and is not drawn when fully visible.

This property determines the visual conditions under which the fill appears, enabling effects like highlighting obscured areas or selectively drawing based on depth.

Code Samples

Methods

Events