UIShadow
CreatorHub

Renders a shadow below the parent UI instance.

Memory category	Instances

Member index 10

History		Member
731		BlurRadius: UDim
731		Color: Color3
731		Enabled: bool
733		Inset: bool
732		Mode: ApplyShadowMode
731		Offset: UDim2
733		ShowBehindParent: bool
731		Spread: UDim2
731		Transparency: float
731		ZIndex: int
68 members inherited from Instance
731		Archivable: bool
731		Attributes: string
731		AttributesReplicate: string
731		AttributesSerialize: BinaryString
731		Capabilities: SecurityCapabilities
731		DataCost: int
731		DefinesCapabilities: bool
731		HistoryId: UniqueId
731		IsInSandbox: bool
731		Name: string
731		Parent: Instance
731		PredictionMode: PredictionMode
731		PropertyStatusStudio: PropertyStatus
731		RobloxLocked: bool
731		Sandboxed: bool
731		SourceAssetId: int64
731		Tags: SharedString
731		UniqueId: UniqueId
731		archivable: bool
731		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
707		GetDescendants(): Instances
486		GetFullName(): string
706		GetStyled(name: string, selector: string?): Variant
657		GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
664		IsPropertyModified(property: string): bool
698		QueryDescendants(selector: string): Instances
573		Remove(): null
576		RemoveTag(tag: string): null
664		ResetPropertyToDefault(property: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
731		children(): Instances
731		clone(): Instance
731		destroy(): null
731		findFirstChild(name: string, recursive: bool = false): Instance
731		getChildren(): Instances
731		isDescendantOf(ancestor: Instance): bool
731		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
657		StyledPropertiesChanged()
731		childAdded(child: Instance)
6 members inherited from Object
731		ClassName: string
731		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
731		isA(className: string): bool
647		Changed(property: string)

Description

UIShadow renders a drop shadow below its parent UI instance. Key features include:

Adjust the shadow's bluriness with BlurRadius.
Adjust the shadow's color and transparency with Color and Transparency.
Adjust the shadow's position and size relative to the parent with Offset and Spread.
Add multiple shadows under the same parent and adjust their render order with ZIndex.
If the parent is rotated with GuiObject.Rotation, the shadow will also be rotated.
If the parent has round corners with UICorner, the shadow will also have round corners.

Limitations

UIShadow does not support text. If you add a UIShadow to a TextLabel or TextButton, it renders a shadow of the object's rectangular bounding area, not of the text.
UIShadow does not support inset shadows.
UIShadow does not support Path2D.
You cannot apply textures or UIGradients to a UIShadow.

History 27
Hide member changes

733 Add ShowBehindParent
733 Add Inset
732 Add Mode
731 Change Default of ZIndex from to -1
731 Change Default of Transparency from to 0
731 Change Default of Spread from to UDim2({0, 0}, {0, 0})
731 Change Default of Offset from to UDim2({0, 0}, {0, 0})
731 Change Default of Enabled from to true
731 Change Default of Color from to Color3(0, 0, 0)
731 Change Default of BlurRadius from to UDim(0, 0)
727 Change Tags of UIShadow from [NotBrowsable] to []
726 Change Default of ZIndex from -1 to
726 Change Default of Transparency from 0 to
726 Change Default of Spread from UDim2({0, 0}, {0, 0}) to
726 Change Default of Offset from UDim2({0, 0}, {0, 0}) to
726 Change Default of Enabled from true to
726 Change Default of Color from Color3(0, 0, 0) to
726 Change Default of BlurRadius from UDim(0, 0) to
724 Add Enabled
713 Change Tags of UIShadow from [] to [NotBrowsable]
711 Add ZIndex
711 Add Transparency
711 Add Spread
711 Add Offset
711 Add Color
711 Add BlurRadius
711 Add UIShadow

Members 10

BlurRadius
CreatorHub

Type		Default
UDim		0, 0

This property determines the shadow's blurriness. A larger value makes the shadow's edges appear softer.

Note that the scale factor of this UDim property is relative to the parent's width or height, whichever is shorter. This property must also be non-negative; a negative value will be treated as 0.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

731 Change Default of BlurRadius from to UDim(0, 0)
726 Change Default of BlurRadius from UDim(0, 0) to
711 Add BlurRadius

Color
CreatorHub

Type		Default
Color3		0, 0, 0

This property determines the shadow's color.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

731 Change Default of Color from to Color3(0, 0, 0)
726 Change Default of Color from Color3(0, 0, 0) to
711 Add Color

Enabled
CreatorHub

Type		Default
bool		true

This property determines whether the UIShadow is visible. Default is true.

Thread safety	ReadSafe
Category	Data
Loaded/Saved	true

History 3

731 Change Default of Enabled from to true
726 Change Default of Enabled from true to
724 Add Enabled

Type	Default
bool	false

Type	Default
ApplyShadowMode	Shape

Offset
CreatorHub

Type		Default
UDim2		{0, 0}, {0, 0}

This property moves the shadow relative to the parent's position. The X scale factor is relative to the parent's width, and the Y scale factor is relative to the parent's height.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

731 Change Default of Offset from to UDim2({0, 0}, {0, 0})
726 Change Default of Offset from UDim2({0, 0}, {0, 0}) to
711 Add Offset

ShowBehindParent
CreatorHub

Type		Default
bool		true

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 1

733 Add ShowBehindParent

Spread
CreatorHub

Type		Default
UDim2		{0, 0}, {0, 0}

This property expands or shrinks the shadow relative to the parent's size. The X scale factor is relative to the parent's width, and the Y scale factor is relative to the parent's height. Properties that are relative to the parent's size, such as the scale factors of BlurRadius and Offset, are not affected by Spread.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

731 Change Default of Spread from to UDim2({0, 0}, {0, 0})
726 Change Default of Spread from UDim2({0, 0}, {0, 0}) to
711 Add Spread

Transparency
CreatorHub

Type		Default
float		0

This property sets the shadow's transparency, with 0 being fully opaque and 1 being fully transparent.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

731 Change Default of Transparency from to 0
726 Change Default of Transparency from 0 to
711 Add Transparency

ZIndex
CreatorHub

Type		Default
int		-1

If a UI instance has multiple shadows, they are rendered in order of increasing ZIndex. Since all shadows are rendered below the parent instance, ZIndex can only be negative.

Thread safety	ReadSafe
Category	Appearance
Loaded/Saved	true

History 3

731 Change Default of ZIndex from to -1
726 Change Default of ZIndex from -1 to
711 Add ZIndex

Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UIShadow
CreatorHub

Member index 10

Description

Limitations

History 27
Hide member changes

Members 10

BlurRadius
CreatorHub

History 3

Color
CreatorHub

History 3

Enabled
CreatorHub

History 3

Inset
CreatorHub

History 1

Mode
CreatorHub

History 1

Offset
CreatorHub

History 3

ShowBehindParent
CreatorHub

History 1

Spread
CreatorHub

History 3

Transparency
CreatorHub

History 3

ZIndex
CreatorHub

History 3

Settings