Data type
DockWidgetPluginGuiInfo
Describes details for a DockWidgetPluginGui.
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 1#
| new | Returns a new DockWidgetPluginGuiInfo object. |
new(InitialDockState: InitialDockState = Enum.InitialDockState.Right, InitialEnabled: bool = false, InitialEnabledShouldOverrideRestore: bool = false, FloatingXSize: number = 0, FloatingYSize: number = 0, MinWidth: number = 0, MinHeight: number = 0)#
The main constructor function for the DockWidgetPluginGuiInfo.
| Name | Type | Default | Description |
|---|---|---|---|
InitialDockState | InitialDockState | Enum.InitialDockState.Right | |
InitialEnabled | bool | false | |
InitialEnabledShouldOverrideRestore | bool | false | |
FloatingXSize | number | 0 | |
FloatingYSize | number | 0 | |
MinWidth | number | 0 | |
MinHeight | number | 0 |
Properties 6#
InitialEnabledbool | The enabled state of the PluginGui if it does not have a saved
state from a previous session. |
InitialEnabledShouldOverrideRestorebool | If true, will override any saved enabled state with the InitialEnabled
value. |
FloatingXSizenumber | The initial pixel width of the PluginGui when floating. |
FloatingYSizenumber | The initial pixel height of the PluginGui when floating. |
MinWidthnumber | The minimum pixel width of the PluginGui. |
MinHeightnumber | The minimum pixel height of the PluginGui. |
InitialEnabled: bool#
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: bool#
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().
FloatingXSize: number#
The initial pixel width of a PluginGui created using this
DockWidgetPluginGuiInfo, when the InitialDockState is
set to Float.
FloatingYSize: number#
The initial pixel height of a PluginGui created using this
DockWidgetPluginGuiInfo, when the InitialDockState is
set to Float.
MinWidth: number#
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: number#
The minimum height of a PluginGui created using this
DockWidgetPluginGuiInfo, in pixels.