Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UICorner

UI modifier which applies deformation to corners of its parent GuiObject.

Memory categoryInstances

Member index 5

HistoryMember
721BottomLeftRadius: UDim
721BottomRightRadius: UDim
721CornerRadius: UDim
721TopLeftRadius: UDim
721TopRightRadius: UDim
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

UICorner is a modifier which applies deformation to corners of its parent GuiObject. Input, but not descendants, will be clipped to the round corner area. See UI appearance modifiers for examples.

In order to keep the circular shape of round corners, each corner radius (UDim) is internally calculated as follows:

  • The radius of the X axis is always the same as the radius of Y axis.
  • Scale rounding will always apply to the minimum width or height.
  • Rounded rectangles will always be in a "pill" shape if CornerRadius is set to a value that leads to a calculated result greater than half of the rectangle's minimum width or height.

Alternatively to UICorner, rounded corners can be accomplished using slices which are suitable for decorative borders that are not simply rounded. See 9‑Slice Design for details.

Note that UICorner can not be applied to a ScrollingFrame.

Individual Corners

Each corner has its own radius property (TopLeftRadius, TopRightRadius, BottomRightRadius, BottomLeftRadius). The CornerRadius property is a convenience shorthand that sets all four corners at once and reads from TopLeftRadius.

When using styling with UICorner, avoid configuring both CornerRadius and the individual corner radii in style rules at the same time, as this may produce unexpected results.

History 75

Members 5

BottomLeftRadius

TypeDefault
UDim0, 8

This property is currently in beta. To use it, enable New UI Capabilities in Studio's beta features window.

A UDim property that determines the radius of the bottom-left corner independently. Setting CornerRadius overwrites all four individual corner radii to the same value.

Thread safetyReadSafe
CategoryIndividual Corners
Loaded/Savedtrue

History 16

BottomRightRadius

TypeDefault
UDim0, 8

This property is currently in beta. To use it, enable New UI Capabilities in Studio's beta features window.

A UDim property that determines the radius of the bottom-right corner independently. Setting CornerRadius overwrites all four individual corner radii to the same value.

Thread safetyReadSafe
CategoryIndividual Corners
Loaded/Savedtrue

History 16

CornerRadius

TypeDefault
UDim0, 8

A convenience UDim property that acts as a shorthand for the four individual corner radius properties. Writing to this property sets TopLeftRadius, TopRightRadius, BottomRightRadius, and BottomLeftRadius to the same value. Reading this property returns the value of TopLeftRadius.

This property is not replicated. Its interface does not cross the network boundary.
Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue/false

History 10

Tags: [NotReplicated]

TopLeftRadius

TypeDefault
UDim0, 8

This property is currently in beta. To use it, enable New UI Capabilities in Studio's beta features window.

A UDim property that determines the radius of the top-left corner independently. Setting CornerRadius overwrites all four individual corner radii to the same value.

Thread safetyReadSafe
CategoryIndividual Corners
Loaded/Savedtrue

History 16

TopRightRadius

TypeDefault
UDim0, 8

This property is currently in beta. To use it, enable New UI Capabilities in Studio's beta features window.

A UDim property that determines the radius of the top-right corner independently. Setting CornerRadius overwrites all four individual corner radii to the same value.

Thread safetyReadSafe
CategoryIndividual Corners
Loaded/Savedtrue

History 16

Settings