PluginGui

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

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

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.

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

See also:

• PluginGui.PluginDragEntered
• PluginGui.PluginDragLeft
• PluginGui.PluginDragMoved

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:

• PluginGui.PluginDragLeft
• PluginGui.PluginDragMoved
• PluginGui.PluginDragDropped

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:

• PluginGui.PluginDragEntered
• PluginGui.PluginDragMoved
• PluginGui.PluginDragDropped

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

See also:

• PluginGui.PluginDragEntered
• PluginGui.PluginDragLeft
• PluginGui.PluginDragDropped

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.

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.