DockWidgetPluginGuiInfo

The DockWidgetPluginGuiInfo data type describes details for a DockWidgetPluginGui. This data type is used when constructing a PluginGui via the plugin's Plugin:CreateDockWidgetPluginGuiAsync() method.

Constructors

Name	Type / Returns	Description
DockWidgetPluginGuiInfo.new		Returns a new DockWidgetPluginGuiInfo object.

DockWidgetPluginGuiInfo.new

The main constructor function for the DockWidgetPluginGuiInfo.

Parameters

Name	Type	Default
InitialDockState	InitialDockState	Enum.InitialDockState.Right
InitialEnabled	bool	false
InitialEnabledShouldOverrideRestore	bool	false
FloatingXSize	number	0
FloatingYSize	number	0
MinWidth	number	0
MinHeight	number	0

Properties

Name	Type / Returns	Description
DockWidgetPluginGuiInfo.InitialEnabled	bool	The enabled state of the `PluginGui` if it does not have a saved state from a previous session.
DockWidgetPluginGuiInfo.InitialEnabledShouldOverrideRestore	bool	If true, will override any saved enabled state with the `InitialEnabled` value.
DockWidgetPluginGuiInfo.FloatingXSize	number	The initial pixel width of the PluginGui when floating.
DockWidgetPluginGuiInfo.FloatingYSize	number	The initial pixel height of the PluginGui when floating.
DockWidgetPluginGuiInfo.MinWidth	number	The minimum pixel width of the PluginGui.
DockWidgetPluginGuiInfo.MinHeight	number	The minimum pixel height of the PluginGui.

DockWidgetPluginGuiInfo.InitialEnabled

The initial enabled state of a PluginGui created using this DockWidgetPluginGuiInfo. If a PluginGui with the same ''pluginGuiId'' has previously been created in an earlier session of Roblox Studio, then it will reload that saved enabled state (unless InitialEnabledShouldOverrideRestore is true).

Field	Value
type	bool

DockWidgetPluginGuiInfo.InitialEnabledShouldOverrideRestore

If true, the value of InitialEnabled will override the previously saved enabled state of a PluginGui being created with this DockWidgetPluginGuiInfo. The previously saved enabled state is loaded based on the pluginGuiId argument of Plugin:CreateDockWidgetPluginGuiAsync().

Field	Value
type	bool

DockWidgetPluginGuiInfo.FloatingXSize

The initial pixel width of a PluginGui created using this DockWidgetPluginGuiInfo, when the InitialDockState is set to Float.

Field	Value
type	number

DockWidgetPluginGuiInfo.FloatingYSize

The initial pixel height of a PluginGui created using this DockWidgetPluginGuiInfo, when the InitialDockState is set to Float.

Field	Value
type	number

DockWidgetPluginGuiInfo.MinWidth

The minimum width of a PluginGui created using this DockWidgetPluginGuiInfo, in pixels.

Each platform has its own absolute minimum that Roblox will enforce. These variations exist to account for the contents of the title bar (which varies by platform) when the widget is floating. For example, on a Mac, the width can never be less than ~80 pixels to accommodate the close/minimize/maximize buttons.

Field	Value
type	number

DockWidgetPluginGuiInfo.MinHeight

The minimum height of a PluginGui created using this DockWidgetPluginGuiInfo, in pixels.

Field	Value
type	number