PluginGui¶
Not yet Class NotCreatable NotReplicated
An abstract base class for GUIs that display GuiObjects in Roblox Studio widgets.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
0 Nova members · 22 modern Roblox members not implemented yet
Description¶
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!
Inheritance¶
Object → Instance → GuiBase → GuiBase2d → LayerCollector → PluginGui
Known subclasses: DockWidgetPluginGui, QWidgetPluginGui
Properties¶
| Member | Signature | Summary |
|---|---|---|
Plugin |
Plugin: Plugin |
— |
Title |
Title: string |
The title that is displayed above the contents of the PluginGui. |
Methods¶
| Member | Signature | Summary |
|---|---|---|
BindToClose |
PluginGui:BindToClose(function: Function = nil): null |
Binds a function that runs when the user closes the PluginGui. |
GetRelativeMousePosition |
PluginGui:GetRelativeMousePosition(): Vector2 |
Returns the position of the mouse relative to the PluginGui. |
OverrideStudioAction |
PluginGui:OverrideStudioAction(studioAction: StudioAction): StudioActionOverride |
— |
Events¶
| Member | Signature | Summary |
|---|---|---|
InputBegan |
InputBegan(input: InputObject, gameProcessedEvent: bool) |
— |
InputChanged |
InputChanged(input: InputObject, gameProcessedEvent: bool) |
— |
InputEnded |
InputEnded(input: InputObject, gameProcessedEvent: bool) |
— |
MouseEnter |
MouseEnter() |
— |
MouseLeave |
MouseLeave() |
— |
PluginDragDropped |
PluginDragDropped(dragData: Dictionary) |
Fires when the user releases their mouse when hovering over a PluginGui during a drag operation started by Plugin.StartDrag(). |
PluginDragEntered |
PluginDragEntered(dragData: Dictionary) |
Fires when the user's mouse enters a PluginGui during a drag operation started by Plugin.StartDrag(). |
PluginDragLeft |
PluginDragLeft(dragData: Dictionary) |
Fires when the user's mouse leaves a PluginGui during a drag operation started by Plugin.StartDrag(). |
PluginDragMoved |
PluginDragMoved(dragData: Dictionary) |
Fires when the user's mouse moves within a PluginGui during a drag operation started by Plugin.StartDrag(). |
PointerAction |
PointerAction(wheel: float, pan: Vector2, pinch: float, gameProcessedEvent: bool) |
— |
WindowFocused |
WindowFocused() |
Fires when the user begins interacting with the window of the PluginGui. |
WindowFocusReleased |
WindowFocusReleased() |
Fires when the user stops interacting with the window of the PluginGui. |
Roblox reference: PluginGui
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.