Engine

GetTextBoundsParams

Show Deprecated
not replicated

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

Code Samples

TextService: Measuring text size

local TextService = game:GetService("TextService")
local params = Instance.new("GetTextBoundsParams")
params.Text = "hello world!"
params.Font = Font.new("rbxasset://fonts/families/GrenzeGotisch.json", Enum.FontWeight.Thin)
params.Size = 20
params.Width = 200
local size = TextService:GetTextBoundsAsync(params)
print("The size of the text is:", size)

Summary

Properties

  • read parallel

    The Font of the text being measured.

  • read parallel

    The size of the text being measured.

  • read parallel

    The text being measured.

  • read parallel

    The width of the container for line breaking.

Properties

read parallel

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

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

Size

read parallel

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

Text

read parallel

The text being measured.

Width

read parallel

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.

Methods

Events