Skip to content

BaseButtonProperties 

export type BaseButtonProperties = {
    Activated: (() -> nil)?,
    Enabled: CanBeState<boolean>?,
    TextSize: CanBeValue<number>?,
    TextColorStyle: CanBeState<Enum.StudioStyleGuideColor>?,
    BackgroundColorStyle: CanBeState<Enum.StudioStyleGuideColor>?,
    BorderColorStyle: CanBeState<Enum.StudioStyleGuideColor>?,
    CornerRadius: CanBeState<UDim>?,
    Timeout: CanBeValue<number>?,
    [any]: any,
}

The BaseButtonProperties table that is given to the BaseButton() function that contains data about the desired BaseButton.

Properties

Activated : (() -> nil)?

The callback function that will be called when the BaseButton is activated.

Enabled : CanBeState<boolean>?

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

TextSize : CanBeValue<number>?

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

TextColorStyle : CanBeState<Enum.StudioStyleGuideColor>?

Sets the color style of the text to the given Enum or a State containing that Enum.

BackgroundColorStyle : CanBeState<Enum.StudioStyleGuideColor>?

Sets the color style of the background to the given Enum or a State containing that Enum.

BorderColorStyle : CanBeState<Enum.StudioStyleGuideColor>?

Sets the color style of the border to the given Enum or a State containing that Enum.

CornerRadius : CanBeState<UDim>?

Sets the corner radius of the BaseButton. Can either be a State containing an UDim, or an UDim.

Timeout : CanBeValue<number>?

This property determines if the BaseButton will be disabled for a certain period of time after it's been activated. Can either be a Value containing a number, or a number.