PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar
  1. API Reference

DockWidgetPluginGuiInfo

Hide content
  1. API Reference
  2. DataType Index

DockWidgetPluginGuiInfo

DockWidgetPluginGuiInfo is a datatype used to describe details for a DockWidgetPluginGui. This datatype is used when constructing a PluginGui via the plugin’s Plugin/CreateDockWidgetPluginGui|CreateDockWidgetPluginGui() method.

Constructors

DockWidgetPluginGuiInfo.new ( Enum initDockState = Enum.InitialDockState.Right, bool initEnabled = false, bool overrideEnabledRestore = false, int floatXSize = 0, int floatYSize = 0, int minWidth = 0, int minHeight = 0 )

The main constructor function for the DockWidgetPluginGuiInfo.

Properties

bool 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).
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/CreateDockWidgetPluginGui.
int DockWidgetPluginGuiInfo.FloatingXSize

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

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

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

Please note: 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.
int DockWidgetPluginGuiInfo.MinHeight

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