10 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

PluginGui

Inherits from: LayerCollector → GuiBase2d → GuiBase → Instance → Object

PluginGui is an abstract class for GUIs that allow the display of GuiObjects in various Roblox Studio widgets. As of right now, the only available PluginGui type is DockWidgetPluginGui, but there may be more in the future!

Inherits from: LayerCollector

Descendants: DockWidgetPluginGui

Memory category: Instances

Tags: NotCreatable, NotReplicated

Properties

Name	Type / Returns	Description
PluginGui.Title	string	The title that is displayed above the contents of the `PluginGui`.

Inherited from LayerCollector

Name	Type / Returns	Description
LayerCollector.Enabled	boolean	Toggles the visibility of this `LayerCollector`.
LayerCollector.ResetOnSpawn	boolean	Determines if the `LayerCollector` resets (deletes itself and re-clones into the player's `PlayerGui`) every time the player's character respawns.
LayerCollector.ZIndexBehavior	ZIndexBehavior	Controls how `GuiObject.ZIndex` behaves on all descendants of this `LayerCollector`.

Inherited from GuiBase2d

Name	Type / Returns	Description
GuiBase2d.AbsolutePosition	Vector2	Describes the actual screen position of a `GuiBase2d` element, in pixels.
GuiBase2d.AbsoluteRotation	float	Describes the actual screen rotation of a `GuiBase2d` element, in degrees.
GuiBase2d.AbsoluteSize	Vector2	Describes the actual screen size of a `GuiBase2d` element, in pixels.
GuiBase2d.AutoLocalize	boolean	When set to `true`, localization will be applied to this `GuiBase2d` and its descendants.
GuiBase2d.Localize	boolean	Automatically set to true when a localization table's `LocalizationTable.Root` targets this object, or an ancestor of this object.
GuiBase2d.RootLocalizationTable	LocalizationTable	A reference to a `LocalizationTable` to be used to apply automated localization to this `GuiBase2d` and its descendants.
GuiBase2d.SelectionBehaviorDown	SelectionBehavior	Customizes gamepad selection behavior in the down direction.
GuiBase2d.SelectionBehaviorLeft	SelectionBehavior	Customizes gamepad selection behavior in the left direction.
GuiBase2d.SelectionBehaviorRight	SelectionBehavior	Customizes gamepad selection behavior in the right direction.
GuiBase2d.SelectionBehaviorUp	SelectionBehavior	Customizes gamepad selection behavior in the up direction.
GuiBase2d.SelectionGroup	boolean	Allows customization of gamepad selection movement.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

PluginGui.Title

The title that is displayed above the contents of the PluginGui. Defaults to empty string.

Field	Value
type	string
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Data
serialization	{"can_load":true,"can_save":true}
capabilities	["UI"]

Methods

Name	Type / Returns	Description
PluginGui:BindToClose	()	Binds a function that runs when the user closes the `PluginGui`.
PluginGui:GetRelativeMousePosition	Vector2	Returns the position of the mouse relative to the PluginGui.

Inherited from LayerCollector

Name	Type / Returns	Description
LayerCollector:GetLayoutNodeTree	Dictionary

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

PluginGui:BindToClose

This method binds a function that runs when the user clicks the close button of the PluginGui. The widget closes and its Enabled property becomes false even when a function is bound, so the function can't prevent or delay closing. Use it to perform tasks such as saving work when the widget closes.

For example, the following code saves work when the user closes the widget:

local function saveWork()
	-- Save the user's work here.
end

pluginGui:BindToClose(function()
	saveWork()
end)

Call BindToClose() without an argument to unbind the current function:

pluginGui:BindToClose()

See also:

Plugin:CreateDockWidgetPluginGuiAsync() to create a PluginGui
DataModel:BindToClose(), which can be used to bind a function to the game ending and should not be confused with this function

Parameters

Name	Type	Default	Description
function	Function	nil	The function to bind the close button to. If no function is specified then any previously specified function will be unbound.

Returns

Type	Description
()

Field	Value
security	None
thread safety	Unsafe
capabilities	["UI"]

PluginGui:GetRelativeMousePosition

GetRelativeMousePosition returns the position of the mouse relative to the top-left corner of the PluginGui. The returned value changes only if a mouse input began on the PluginGui, or if the mouse is presently hovering over the window.

Returns

Type	Description
Vector2	The screen position of the mouse relative to the PluginGui in pixels.

Field	Value
security	PluginSecurity
thread safety	Unsafe
capabilities	["UI"]

Code samples: View on Creator Hub (plugingui-getrelativemouseposition).

Events

Name	Type / Returns	Description
PluginGui.PluginDragDropped		Fires when the user releases their mouse when hovering over a PluginGui during a drag operation started by `Plugin:StartDrag()`.
PluginGui.PluginDragEntered		Fires when the user's mouse enters a PluginGui during a drag operation started by `Plugin:StartDrag()`.
PluginGui.PluginDragLeft		Fires when the user's mouse leaves a PluginGui during a drag operation started by `Plugin:StartDrag()`.
PluginGui.PluginDragMoved		Fires when the user's mouse moves within a PluginGui during a drag operation started by `Plugin:StartDrag()`.
PluginGui.WindowFocused		Fires when the user begins interacting with the window of the PluginGui.
PluginGui.WindowFocusReleased		Fires when the user stops interacting with the window of the PluginGui.

Inherited from GuiBase2d

Name	Type / Returns	Description
GuiBase2d.SelectionChanged		Fires when the gamepad selection moves to, leaves, or changes within the connected `GuiBase2d` or any descendant `GuiObjects`.

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.

PluginGui.PluginDragDropped

PluginDragDropped fires when the user releases their mouse over a PluginGui during a drag operation started by Plugin:StartDrag().

See also:

Parameters

Name	Type	Default	Description
dragData	Dictionary		A copy of the data originally passed to `Plugin:StartDrag()`.

Field	Value
security	PluginSecurity
capabilities	["UI"]

Code samples: View on Creator Hub (plugin-drag-and-drop).

PluginGui.PluginDragEntered

PluginDragEntered fires when the user's mouse enters the PluginGui during a drag operation started by Plugin:StartDrag().

This event is useful for displaying a "Drop Here" UI on PluginGuis where a drag operation can be dropped. Such a UI should be hidden when either PluginDragLeft or PluginDragDropped fire.

See also:

Parameters

Name	Type	Default	Description
dragData	Dictionary		A copy of the data originally passed to `Plugin:StartDrag()`.

Field	Value
security	PluginSecurity
capabilities	["UI"]

Code samples: View on Creator Hub (plugin-drag-and-drop).

PluginGui.PluginDragLeft

PluginDragLeft fires when the user's mouse leaves a PluginGui during a drag operation started by Plugin:StartDrag().

This event and PluginDragDropped are useful for hiding a "Drop Here" UI on PluginGuis where a drag operation can be dropped. Such a UI should be shown when either PluginDragEntered fires.

See also:

Parameters

Name	Type	Default	Description
dragData	Dictionary		A copy of the data originally passed to `Plugin:StartDrag()`.

Field	Value
security	PluginSecurity
capabilities	["UI"]

Code samples: View on Creator Hub (plugin-drag-and-drop).

PluginGui.PluginDragMoved

PluginDragMoved fires when the user's mouse moves within a PluginGui during a drag operation started by Plugin:StartDrag().

See also:

Parameters

Name	Type	Default	Description
dragData	Dictionary		A copy of the data originally passed to `Plugin:StartDrag()`.

Field	Value
security	PluginSecurity
capabilities	["UI"]

PluginGui.WindowFocused

WindowFocused fires immediately when the user starts interacting with the PluginGui's window, usually by clicking on it. This functions works similarly to the similarly-named UserInputService.WindowFocused event. It fires before any GuiObject.InputBegan events related to mouse buttons.

If another PluginGui is in focus and the user focuses this PluginGui, then this event fires after the other's WindowFocusReleased event. However, if the main game window was in focus, this event fires after UserInputService.WindowFocusReleased.

Field	Value
security	PluginSecurity
capabilities	["UI"]

Code samples: View on Creator Hub (plugingui-focus).

PluginGui.WindowFocusReleased

WindowFocusReleased fires immediately when the user stops interacting with the PluginGui's window, usually by clicking on something not in the window. This functions works similarly to the similarly-named UserInputService.WindowFocusReleased event.

If focus is moving to another PluginGui while the user had this PluginGui in focus, then this event fires before the other's WindowFocused event. However, if the main game window is being put in focus, this event fires after UserInputService.WindowFocused.

Field	Value
security	PluginSecurity
capabilities	["UI"]

Code samples: View on Creator Hub (plugingui-focus).