Skip to content

WidgetProperties

export type WidgetProperties = {
    Id: string,
    Name: string,
    InitialDockTo: string | Enum.InitialDockState,
    InitialEnabled: boolean,
    ForceInitialEnabled: boolean,
    FloatingSize: Vector2,
    MinimumSize: Vector2,
    [any]: any,
}

The WidgetProperties table that is given to the Widget() function that contains data about the desired Widget.


Properties

Name : string

The name of the Widget.


Id : string

A unique and consistent identifier used to storing the Widget's dock state and other internal details.


InitialDockTo : string | Enum.InitialDockState

Describes the initial docking state of a Widget. Can either be a string or an Enum.


InitialEnabled : boolean

The enabled state of the Widget if it does not have a saved state from a previous session.


ForceInitialEnabled : boolean

If true, will override any saved enabled state with the InitialEnabled value.


FloatingSize : Vector2

The initial pixel width and height of the Widget when floating.


MinimumSize : Vector2

The minimum pixel width and height of the Widget.