Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UIAspectRatioConstraint

Ensures the parent UI element maintains a particular aspect ratio.

Memory categoryInstances

Member index 3

HistoryMember
553AspectRatio: float
553AspectType: AspectType
553DominantAxis: DominantAxis
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Description

A UIAspectRatioConstraint ensures that the parent UI element (GuiObject) maintains a particular aspect ratio even if its size is set as a percentage of its parent. If an object with this constraint is also under the control of a UILayout such as UIGridLayout, then the constraint controls the objects size and overwrites any size the layout would apply.

When applied to a GuiObject, the UIAspectRatioConstraint will make sure that the objects ratio is maintained by the value defined in UIAspectRatioConstraint.AspectRatio. The UIAspectRatioConstraint.AspectType sets what determines the maximum size of the object. When set to AspectType.FitWithinMaxSize, the constraint will make the object the maximum size it can be within the GuiObject of the element. When set to ScaleWithParentSize, the elements maximum size will be the size of the parent while still maintaining the aspect ratio. Finally, the UIAspectRatioConstraint.DominantAxis will determine which axis to use when setting the new size of the element.

History 13

Members 3

AspectRatio

TypeDefault
float1

AspectRatio determines the width-to-height ratio to maintain. To flip the ratio to height-to-width, take the inverse (divide 1 by the number or raise to the -1st power). This value must be greater than zero. Below, a white Frame is placed within the a black Frame with two different width-to-height ratios.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

AspectType

TypeDefault
AspectTypeFitWithinMaxSize

AspectType determines what limits the maximum size of the element.

  • When set to FitWithinMaxSize, the constraint will make the object the maximum size it can be within its own GuiBase2d.AbsoluteSize.
  • When set to ScaleWithParentSize, the UI element's maximum size will be the size of the parent while still maintaining the aspect ratio..
Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

DominantAxis

TypeDefault
DominantAxisWidth

DominantAxis determines which axis to use when setting the new size of the UI element if it would otherwise exceed the size of the parent.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

Settings