Reference API Roblox

Engine API

Website

Related

Reference API Roblox

InitialDockState

Describes the initial docking state of a DockWidgetPluginGui.

Items 5

HistoryNameValueDescription
326Top0

The widget will appear docked above the game screen.

326Bottom1

The widget will appear docked below the game screen.

326Left2

The widget will appear docked to the left of the game screen.

326Right3

The widget will appear docked to the right of the game screen.

326Float4

The widget will not be docked to any side of the game screen, and instead can be freely dragged around.

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.

History 6

Settings