TextLabel
Displays text within a GUI rectangle.
- Creatable
Instance.new("TextLabel")- Inherits
- GuiLabelGuiObjectGuiBase2dGuiBaseInstance
- Replication
- Standard
Behavior
TextLabel displays text and supports background, layout, and text formatting
properties. Use TextButton for button activation.
Set BackgroundTransparency to 1 to hide the label background.
Summary
The resolved top-left position of this interface element in pixels.
The resolved rotation of this interface element in degrees, including ancestor rotation.
The resolved width and height of this interface element in pixels.
Whether this interface accepts and consumes input.
The normalized point within the element used as the origin for Position.
The dimensions that resize to fit the element's content.
The color used to fill the element's background.
The background transparency, from 0 for opaque to 1 for invisible.
The color of the element's border.
Whether the border is drawn outside, across, or inside the element's bounds.
The border thickness in pixels.
Whether descendant rendering is clipped to this element's bounds.
The text content after rich-text markup has been removed.
The corner radius used for the element's rounded background.
The individual corner radii used for the element's rounded background.
Whether pointer dragging can move the element.
The typeface used to render text.
Whether the text uses the monospaced font option.
The style applied to the text, such as normal or italic.
The weight applied to the text, such as regular or bold.
The share of remaining main-axis space assigned to this child in flow layout.
The element's current idle, hover, pressed, or non-interactable state.
Which input events this element consumes before they reach elements behind it.
Whether the element accepts interaction.
Whether children use flow layout or their explicit positions.
The numeric order of this element when a parent layout sorts by layout order.
The additional spacing between text glyphs.
The line-height multiplier used for multi-line text.
The maximum number of visible graphemes.
The interface element selected when navigating down from this element.
The interface element selected when navigating left from this element.
The interface element selected when navigating right from this element.
The interface element selected when navigating up from this element.
The opacity multiplier applied to this element and its descendants.
The element position relative to its parent.
Whether markup in Text is parsed and rendered as rich text.
The interface rotation in degrees.
Whether interface navigation can select this element.
The interface element used to draw the selection indicator.
The numeric order used for interface selection traversal.
The element size relative to its parent.
The parent axes used to resolve relative interface size.
The displayed string.
The resolved pixel bounds of the rendered text.
The text color.
Whether the rendered text fits within the label's bounds.
Whether the engine scales the text to fit the label's bounds.
The base text size in pixels.
The color of the outline around each glyph.
The outline transparency.
The text transparency.
The truncation mode used when text does not fit.
Whether text wraps onto additional lines when it exceeds the label width.
The horizontal alignment within the label.
The vertical alignment within the label.
Whether this interface element is rendered.
The element's draw-order index.
Gives keyboard focus to this interface element.
Returns this instance if it is an ExecutionGroup.
Removes keyboard focus from this interface element.
Fires when pointer dragging of the element begins.
Fires when pointer dragging of the element ends.
Fires when input begins over or is dispatched to this interface element.
Fires when input dispatched to this element changes.
Fires when input dispatched to this element ends.
Fires when the mouse wheel scrolls backward over this element.
Fires when the mouse wheel scrolls forward over this element.
Fires when a pointer moves onto the label.
Fires when a pointer moves off the label.
Fires when the pointer moves across the label.
Fires when interface navigation selects this element.
Fires when this element loses interface selection.
Properties
AbsolutePosition
TextLabel.AbsolutePosition: Vector2 = Vector2.new(0, 0)The resolved top-left position of this interface element in pixels.
AbsoluteRotation
TextLabel.AbsoluteRotation: number = 0The resolved rotation of this interface element in degrees, including ancestor rotation.
AbsoluteSize
TextLabel.AbsoluteSize: Vector2 = Vector2.new(0, 0)The resolved width and height of this interface element in pixels.
Active
TextLabel.Active: boolean = falseWhether this interface accepts and consumes input.
AnchorPoint
TextLabel.AnchorPoint: Vector2 = Vector2.new(0, 0)The normalized point within the element used as the origin for Position. (0, 0) is the top-left corner; (0.5, 0.5) is the center.
AutomaticSize
TextLabel.AutomaticSize: Enum.AutomaticSize = Enum.AutomaticSize.NoneThe dimensions that resize to fit the element's content.
BackgroundColor3
TextLabel.BackgroundColor3: Color3 = Color3.new(0.6392157, 0.63529414, 0.64705884)The color used to fill the element's background.
BackgroundTransparency
TextLabel.BackgroundTransparency: number = 0The background transparency, from 0 for opaque to 1 for invisible.
BorderColor3
TextLabel.BorderColor3: Color3 = Color3.new(0.105882354, 0.16470589, 0.20784314)The color of the element's border.
BorderMode
TextLabel.BorderMode: Enum.BorderMode = Enum.BorderMode.OutlineWhether the border is drawn outside, across, or inside the element's bounds.
BorderSizePixel
TextLabel.BorderSizePixel: number = 1The border thickness in pixels.
ClipsDescendants
TextLabel.ClipsDescendants: boolean = falseWhether descendant rendering is clipped to this element's bounds.
ContentText
TextLabel.ContentText: stringThe text content after rich-text markup has been removed. Read-only.
CornerRadius
TextLabel.CornerRadius: number = 0The corner radius used for the element's rounded background.
Corners
TextLabel.Corners: { number } = {}The individual corner radii used for the element's rounded background.
Draggable
TextLabel.Draggable: boolean = falseWhether pointer dragging can move the element.
FontFace
TextLabel.FontFace: Font = ""The typeface used to render text. FontStyle and FontWeight configure style and weight.
FontMono
TextLabel.FontMono: booleanWhether the text uses the monospaced font option.
FontStyle
TextLabel.FontStyle: Enum.FontStyle = Enum.FontStyle.NormalThe style applied to the text, such as normal or italic.
FontWeight
TextLabel.FontWeight: Enum.FontWeight = Enum.FontWeight.RegularThe weight applied to the text, such as regular or bold.
Grow
TextLabel.Grow: number = 0The share of remaining main-axis space assigned to this child in flow layout.
GuiState
TextLabel.GuiState: Enum.GuiState = Enum.GuiState.IdleThe element's current idle, hover, pressed, or non-interactable state.
InputSink
TextLabel.InputSink: Enum.InputSink = Enum.InputSink.NoneWhich input events this element consumes before they reach elements behind it.
Interactable
TextLabel.Interactable: boolean = trueWhether the element accepts interaction.
Layout
TextLabel.Layout: Enum.Layout = Enum.Layout.FlowWhether children use flow layout or their explicit positions.
LayoutOrder
TextLabel.LayoutOrder: number = 0The numeric order of this element when a parent layout sorts by layout order.
LetterSpacing
TextLabel.LetterSpacing: numberThe additional spacing between text glyphs.
LineHeight
TextLabel.LineHeight: numberThe line-height multiplier used for multi-line text.
MaxVisibleGraphemes
TextLabel.MaxVisibleGraphemes: numberThe maximum number of visible graphemes. Set to a negative value to show all graphemes.
NextSelectionDown
TextLabel.NextSelectionDown: GuiObject? = nilThe interface element selected when navigating down from this element.
NextSelectionLeft
TextLabel.NextSelectionLeft: GuiObject? = nilThe interface element selected when navigating left from this element.
NextSelectionRight
TextLabel.NextSelectionRight: GuiObject? = nilThe interface element selected when navigating right from this element.
NextSelectionUp
TextLabel.NextSelectionUp: GuiObject? = nilThe interface element selected when navigating up from this element.
Opacity
TextLabel.Opacity: number = 1The opacity multiplier applied to this element and its descendants.
Position
The element position relative to its parent. Scale components use the parent size; offsets are in pixels.
RichText
TextLabel.RichText: booleanWhether markup in Text is parsed and rendered as rich text.
Rotation
TextLabel.Rotation: number = 0The interface rotation in degrees.
Selectable
TextLabel.Selectable: boolean = falseWhether interface navigation can select this element.
SelectionImageObject
TextLabel.SelectionImageObject: GuiObject? = nilThe interface element used to draw the selection indicator.
SelectionOrder
TextLabel.SelectionOrder: number = 0The numeric order used for interface selection traversal.
Size
The element size relative to its parent. Scale components use the parent size; offsets are in pixels.
SizeConstraint
TextLabel.SizeConstraint: Enum.SizeConstraint = Enum.SizeConstraint.RelativeXYThe parent axes used to resolve relative interface size.
Text
TextLabel.Text: string = "Label"The displayed string. Assignment updates the text layout.
TextBounds
TextLabel.TextBounds: Vector2The resolved pixel bounds of the rendered text. Read-only.
TextColor3
TextLabel.TextColor3: Color3 = Color3.new(0, 0, 0)The text color.
TextFits
TextLabel.TextFits: booleanWhether the rendered text fits within the label's bounds. Read-only.
TextScaled
TextLabel.TextScaled: booleanWhether the engine scales the text to fit the label's bounds.
TextSize
TextLabel.TextSize: number = 8The base text size in pixels.
TextStrokeColor3
TextLabel.TextStrokeColor3: Color3 = Color3.new(0, 0, 0)The color of the outline around each glyph.
TextStrokeTransparency
TextLabel.TextStrokeTransparency: number = 1The outline transparency. Defaults to fully transparent. Reduce this value to display the outline.
TextTransparency
TextLabel.TextTransparency: number = 0The text transparency. This is independent of BackgroundTransparency.
TextTruncate
TextLabel.TextTruncate: EnumItemThe truncation mode used when text does not fit.
TextWrapped
TextLabel.TextWrapped: boolean = falseWhether text wraps onto additional lines when it exceeds the label width.
TextXAlignment
TextLabel.TextXAlignment: Enum.TextXAlignment = Enum.TextXAlignment.CenterThe horizontal alignment within the label. See Enum.TextXAlignment.
TextYAlignment
TextLabel.TextYAlignment: Enum.TextYAlignment = Enum.TextYAlignment.CenterThe vertical alignment within the label.
Visible
TextLabel.Visible: boolean = trueWhether this interface element is rendered.
ZIndex
TextLabel.ZIndex: number = 1The element's draw-order index. Interpretation depends on the root's ZIndexBehavior.
Methods
CaptureFocus
TextLabel:CaptureFocus(): ()Gives keyboard focus to this interface element.
GetExecutionGroup
TextLabel:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
ReleaseFocus
TextLabel:ReleaseFocus(): ()Removes keyboard focus from this interface element.
Events
DragBegin
TextLabel.DragBegin: RBXScriptSignalFires when pointer dragging of the element begins.
DragStopped
TextLabel.DragStopped: RBXScriptSignalFires when pointer dragging of the element ends.
InputBegan
TextLabel.InputBegan: RBXScriptSignalFires when input begins over or is dispatched to this interface element.
InputChanged
TextLabel.InputChanged: RBXScriptSignalFires when input dispatched to this element changes.
InputEnded
TextLabel.InputEnded: RBXScriptSignalFires when input dispatched to this element ends.
MouseWheelBackward
TextLabel.MouseWheelBackward: RBXScriptSignalFires when the mouse wheel scrolls backward over this element.
MouseWheelForward
TextLabel.MouseWheelForward: RBXScriptSignalFires when the mouse wheel scrolls forward over this element.
PointerEntered
TextLabel.PointerEntered: RBXScriptSignalFires when a pointer moves onto the label.
PointerExited
TextLabel.PointerExited: RBXScriptSignalFires when a pointer moves off the label.
PointerMoved
TextLabel.PointerMoved: RBXScriptSignalFires when the pointer moves across the label.
SelectionGained
TextLabel.SelectionGained: RBXScriptSignalFires when interface navigation selects this element.
SelectionLost
TextLabel.SelectionLost: RBXScriptSignalFires when this element loses interface selection.
Inherited members
- Properties
- CatchesPointer
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying
Example
local label = Instance.new("TextLabel")
label.Text = "Score: 0"
label.BackgroundTransparency = 1