Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
InitialDockState
Specifies where a DockWidgetPluginGui is initially positioned in Roblox Studio when it is created for the first time. The value is supplied as the initialDockState field of DockWidgetPluginGuiInfo, which is passed to Plugin:CreateDockWidgetPluginGuiAsync(). If Roblox Studio has a saved layout entry for the plugin widget, that saved layout takes precedence and this value is ignored; DockWidgetPluginGui.HostWidgetWasRestored is true in that case.
Items
| Name | Value | Description |
|---|---|---|
| Top | 0 | The widget will appear docked above the game screen. |
| Bottom | 1 | The widget will appear docked below the game screen. |
| Left | 2 | The widget will appear docked to the left of the game screen. |
| Right | 3 | The widget will appear docked to the right of the game screen. |
| Float | 4 | The widget will not be docked to any side of the game screen, and instead can be freely dragged around. |
Top
The widget will appear docked above the game screen.
| Field | Value |
|---|---|
| value | 0 |
Bottom
The widget will appear docked below the game screen.
| Field | Value |
|---|---|
| value | 1 |
Left
The widget will appear docked to the left of the game screen.
| Field | Value |
|---|---|
| value | 2 |
Right
The widget will appear docked to the right of the game screen.
| Field | Value |
|---|---|
| value | 3 |
Float
The widget will not be docked to any side of the game screen, and instead can be freely dragged around.
| Field | Value |
|---|---|
| value | 4 |