Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
TextService
Inherits from: Instance → Object
TextService is internally responsible for handling the display of text.
Inherits from: Instance
Memory category: Instances
Tags: NotCreatable, Service, NotReplicated
Methods
| Name | Type / Returns | Description |
|---|---|---|
| TextService:FilterAndTranslateStringAsync | TextFilterTranslatedResult | Filters and translates a string. |
| TextService:FilterStringAsync | TextFilterResult | Filters a string being received from a user and returns a |
| TextService:GetFamilyInfoAsync | Dictionary | Returns a table containing the name and faces of a font family. |
| TextService:GetTextBoundsAsync | Vector2 | Computes the Vector2 dimensions (in pixels) that will be taken up with text when using a GetTextBoundsParams object. |
| TextService:GetTextSize | Vector2 | Computes the Vector2 dimensions (in pixels) that will be taken up with text when using the specified formatting parameters and size constraints. |
| TextService:GetTextSizeOffsetAsync | float | Returns the offset used to up-scale text based on the current GuiService.PreferredTextSize setting. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
TextService:FilterAndTranslateStringAsync
Deprecated. This method is no longer supported and should not be used. All calls return an empty object.
This method is no longer supported and should not be used. Translating chat messages is only available via TextChatService.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| stringToFilter | string | ||
| fromUserId | int64 | ||
| targetLocales | Array | ||
| textContext | TextFilterContext | PrivateChat |
Returns
| Type | Description |
|---|---|
| TextFilterTranslatedResult |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
TextService:FilterStringAsync
This method filters a string being received from a user and returns a TextFilterResult which can be used to distribute the correctly filtered text accordingly.
This method should be called once each time a user submits a message. If it fails, do not display the text to any user.
See text filtering for usage guidelines and examples.
Notes
- This method always yields to make a text filtering service call.
- This method may throw if there is a service error that cannot be resolved. In such cases, do not retry the request, as this method implements its own retry logic internally.
- This method currently throws if
fromUserIdis not online on the current server.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| stringToFilter | string | The text to be filtered. | |
| fromUserId | int64 | The Player.UserId of the player filtering the text. | |
| textContext | TextFilterContext | PrivateChat | The context that the filtered message will be used in. This parameter does not impact the filtered result of the query and is only used to improve Roblox's text filtering. |
Returns
| Type | Description |
|---|---|
| TextFilterResult | A TextFilterResult that wraps the filtered text and exposes methods for retrieving it in the form appropriate for each audience. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (pet-name-filter-example).
TextService:GetFamilyInfoAsync
Returns a table containing the name and faces of a font family. If the font family has already been loaded by a previous call to GetFamilyInfoAsync(), ContentProvider:PreloadAsync(), or a text object with the TextLabel.FontFace property set, then the method returns without yielding.
This method can fail because of network errors and should be wrapped in LuaGlobals.pcall() to catch and handle errors.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| assetId | ContentId | Asset ID of the font family to look up. |
Returns
| Type | Description |
|---|---|
| Dictionary | The information about the font family. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (TextService-GetFamilyInfoAsync-1).
TextService:GetTextBoundsAsync
Computes the Vector2 dimensions (in pixels) that will be taken up with text when using parameters defined in a GetTextBoundsParams object. This method is similar to GetTextSize() but uses the Font object which has access to more fonts than Font.
This method is a useful alternative to the TextBounds property of the TextLabel/TextButton objects, since GetTextBoundsAsync() can calculate the dimensions required by a particular text string in a TextLabel or TextButton before such an object is created or text property set.
This is a yielding method because some fonts may need to be loaded in order to measure them. As a result, it should be wrapped in LuaGlobals.pcall() to catch and handle errors. If the font is already loaded, it will not yield; ContentProvider:PreloadAsync() can be used to make sure a font is loaded.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| params | GetTextBoundsParams | A reference to a GetTextBoundsParams object. |
Returns
| Type | Description |
|---|---|
| Vector2 | The size of the text as a Vector2. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (TextService-GetTextBoundsAsync-1).
TextService:GetTextSize
Computes the Vector2 dimensions (in pixels) that will be taken up with text when using the specified formatting parameters and size constraints.
This method is a useful alternative to the TextBounds property of the TextLabel/TextButton objects, since GetTextSize() can calculate the dimensions required by a particular text string in a TextLabel or TextButton before such an object is created or text property set.
This method is limited to fonts under Font. To access more fonts under Font, use GetTextBoundsAsync() instead.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| string | string | The string for which the text size is to be calculated. | |
| fontSize | int | The integer representing the font size used. Does not accept an FontSize value. | |
| font | Enum.Font | The font used. | |
| frameSize | Vector2 | The GuiBase2d.AbsoluteSize of the text object to be used. Required to compute how the text will wrap. |
Returns
| Type | Description |
|---|---|
| Vector2 | The size of the space required, in pixels, by the string with the specified formatting. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (textservice-getting-the-text-size).
TextService:GetTextSizeOffsetAsync
Returns the offset used to up-scale text based on GuiService.PreferredTextSize, a property which may change through the player's setting in the Roblox or in‑experience Settings menus.
This offset can be used as an additive value to adjust the core height value of a TextLabel or TextButton based on PreferredTextSize.
Note that, currently, the fontSize and font parameters do not affect the outcome and this method returns merely the offset as described above. Also note that this method can fail because of network errors and should be wrapped in LuaGlobals.pcall() to catch and handle errors.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| fontSize | int | The font size, in offsets. This parameter currently does not affect the returned offset. | |
| font | Datatype.Font | The font. This parameter currently does not affect the returned offset. |
Returns
| Type | Description |
|---|---|
| float | The offset, in pixels, to add to the height of a TextLabel or TextButton to up-scale it for the player's current PreferredTextSize setting. |
| Field | Value |
|---|---|
| tags | ["Yields"] |
| security | None |
| thread safety | Unsafe |
| capabilities | ["UI"] |
Code samples: View on Creator Hub (TextService-GetTextSizeOffsetAsync).
Properties
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
Events
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |