Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GetTextBoundsParams

Use with TextService:GetTextBoundsAsync() to measure the size of text.

This class is not replicated. Its interface does not cross the network boundary.
Memory categoryInstances
Tags: [NotReplicated]

Member index 5

HistoryMember
553Font: Font
631RichText: bool
553Size: float
529Text: string
553Width: float
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
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

Pass this instance to TextService:GetTextBoundsAsync() to measure the size of text.

History 9

Members 5

Font

TypeDefault
Font

The Font of the text being measured. Corresponds to the TextLabel.FontFace property on text objects.

Not to be confused with Font. This is an object that you can create using Font.new().

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

RichText

TypeDefault
boolfalse

Determines whether the text being measured is interpreted using rich text markup. Corresponds to the TextLabel.RichText property on text objects.

By default, the value is false, meaning the GetTextBoundsParams.Text string is measured verbatim. When set to true, rich text formatting tags in the string are parsed rather than measured as literal characters, so the returned bounds reflect the styled text.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Size

TypeDefault
float20

The size of the text that is being measured. Corresponds to the TextLabel.TextSize property.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Text

TypeDefault
string

The text being measured.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Width

TypeDefault
float0

The width of the container for line breaking. By default, the value is 0, which means no line breaking will be performed. You can set it to the width of the container that you'll be putting the text into.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 2

Settings