Skip to content

InitialDockState

Not yet Enum

Describes the initial docking state of a DockWidgetPluginGui.

Not implemented in Nova

This enum is missing from Nova. Scripts that reference it will fail.

Description

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

Item Value Status Notes
Top 0 Not yet The widget will appear docked above the game screen.
Bottom 1 Not yet The widget will appear docked below the game screen.
Left 2 Not yet The widget will appear docked to the left of the game screen.
Right 3 Not yet The widget will appear docked to the right of the game screen.
Float 4 Not yet The widget will not be docked to any side of the game screen, and instead can be freely dragged around.

Roblox reference: InitialDockState