DockWidgetPluginGuiInfo

Constructors

NameDescription
new(InitialDockState: Enum.InitialDockState,InitialEnabled: boolean,InitialEnabledShouldOverrideRestore: boolean,FloatingXSize: number,FloatingYSize: number,MinWidth: number,MinHeight: number)Returns a new DockWidgetPluginGuiInfo, used when constructing a PluginGui via Plugin:CreateDockWidgetPluginGuiAsync().

Code Snippet

local widgetInfo = DockWidgetPluginGuiInfo.new(
    Enum.InitialDockState.Right,
    true,
    false,
    300,
    200,
    150,
    100
)

local widget = plugin:CreateDockWidgetPluginGuiAsync("MyWidget", widgetInfo)
widget.Title = "My Plugin"
widget.Enabled = true

Properties

NameTypeDescription
InitialEnabledbooleanThe initial enabled state of a PluginGui created using this DockWidgetPluginGuiInfo. If a PluginGui with the same pluginGuiId was created in an earlier Studio session, that saved enabled state is reloaded instead (unless InitialEnabledShouldOverrideRestore is true).
InitialEnabledShouldOverrideRestorebooleanIf true, the value of InitialEnabled overrides any previously saved enabled state of a PluginGui being created with this DockWidgetPluginGuiInfo.
FloatingXSizenumberThe initial pixel width of a PluginGui created using this DockWidgetPluginGuiInfo, when InitialDockState is Float.
FloatingYSizenumberThe initial pixel height of a PluginGui created using this DockWidgetPluginGuiInfo, when InitialDockState is Float.
MinWidthnumberThe minimum pixel width of a PluginGui created using this DockWidgetPluginGuiInfo. Each platform enforces its own absolute minimum.
MinHeightnumberThe minimum pixel height of a PluginGui created using this DockWidgetPluginGuiInfo.