Reference API Roblox

Engine API

Website

Related

Reference API Roblox

UITextSizeConstraint

Ensures that the size of text rendered by certain GuiObject classes lies within the range described by MaxTextSize and MinTextSize.

Memory categoryInstances

Member index 2

HistoryMember
553MaxTextSize: int
553MinTextSize: int
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 UITextSizeConstraint ensures that the size of text rendered by certain GuiObject classes (TextLabel, TextButton, or TextBox) lies within the range described by MaxTextSize and MinTextSize. It is meant to be used alongside TextLabel.TextScaled, which automatically scales text to fill its containing object. Like other UI constraints, it is applied when parented to the object to be constrained.

It's recommended that no values lower than 9 be used for MinTextSize property, otherwise text may not be readable to most users.

History 9

Members 2

MaxTextSize

TypeDefault
int100

This property indicates the largest size in pixels the font is allowed to be. It defaults to 1000 pixels and much be set larger than or equal to the MinTextSize property.

If the affected GuiObject has its TextScaled property set to true the text size constrained by this property will scale dynamically with the container's size. It will scale upwards with the GuiObject's size until the max size is reached, at which point it will stay constant if the UI element continues to grow.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

MinTextSize

TypeDefault
int1

This property indicated the smallest size in pixels the font is allowed to be. This value defaults to 1 pixel and must be set less than or equal to UITextSizeConstraint.MaxTextSize.

If the affected GuiObject has its TextScaled property set to true the text size constrained by this property will scale dynamically with the container's size. It will scale downwards with the GuiObject's size until the min size is reached, at which point it will stay constant if the UI element continues to shrink.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

Settings