Skip to content

LabelProperties 

export type LabelProperties = {
    Enabled: CanBeState<boolean>?,
    Text: CanBeState<string>?,
    TextColor3: CanBeState<Color3>?,
    TextColorStyle: CanBeState<Enum.StudioStyleGuideColor>?,
    TextSize: CanBeState<number>?,
    [any]: any,
}

The LabelProperties table that is given to the Label() function that contains data about the desired Label.

Properties

Enabled : CanBeState<boolean>?

Sets whether the Label will be enabled or not. Can either be a State containing a boolean, or a boolean.

Text : CanBeState<string>?

The text that will be displayed on the Label. Can either be a State containing a string, or a string.

TextColor3 : CanBeState<Color3>?

The color of the text on the Label. Can either be a State containing a Color3, or a Color3. Setting this property is not recommended, as it will overwrite the default color defined by the theme of the Studio.

TextColorStyle : CanBeState<Enum.StudioStyleGuideColor>?

Sets the color style of the text to the given Enum or a State containing that Enum. This property is recommended to use if you want to modify the color of the text while making it consistent with the theme of the Studio.

TextSize : CanBeState<number>?

The size of the text that will be displayed on the Label. Can either be a State containing a number, or a number.