DockWidgetPluginGuiInfo

Show Deprecated

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

Summary

Constructors

Properties

Constructors

new

Parameters

initDockState: Enum.InitialDockState
Default Value: Enum.InitialDockState.Right
initEnabled: bool
Default Value: false
overrideEnabledRestore: bool
Default Value: false
floatXSize: number
Default Value: 0
floatYSize: number
Default Value: 0
minWidth: number
Default Value: 0
minHeight: number
Default Value: 0

Properties

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).

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:CreateDockWidgetPluginGui().

FloatingXSize

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

FloatingYSize

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

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.

MinHeight

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