DockWidgetPluginGui
DockWidgetPluginGui is a PluginGui that displays its contents inside a dockable Roblox Studio window. It is used to create widgets similar to the built-in Animation Editor and Terrain Tools.
This GUI can be created using Plugin:CreateDockWidgetPluginGui().
Summary
Properties
- read onlynot replicatedread parallel
Describes whether the previous state of this DockWidgetPluginGui was restored when it was created.
The title that is displayed above the contents of the PluginGui.
Toggles the visibility of the LayerCollector.
- read parallel
Controls how this LayerCollector behaves when its associated Player respawns.
- read parallel
Controls how GuiObject.ZIndex behaves on all descendants of the LayerCollector.
- read onlynot replicated
Describes the actual screen position of a UI element, in pixels.
- read onlynot replicated
Describes the actual screen rotation of a UI element, in degrees.
- read onlynot replicated
Describes the actual screen size of a UI element, in pixels.
- read parallel
When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d.RootLocalizationTable specified for this GuiBase2d.
- read parallel
A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.
- read parallel
Customizes gamepad selection behavior in the down direction.
- read parallel
Customizes gamepad selection behavior in the left direction.
- read parallel
Customizes gamepad selection behavior in the right direction.
- read parallel
Customizes gamepad selection behavior in the up direction.
- read parallel
Allows customization of gamepad selection movement.
Methods
Methods inherited from PluginGuiBinds a function to the PluginGui's close button, overriding the default behavior.
Returns the position of the mouse relative to the PluginGui.
Events
Events inherited from PluginGuiFires when the user releases their mouse when hovering over a PluginGui during a drag operation started by Plugin:StartDrag().
Fires when the user's mouse enters a PluginGui during a drag operation started by Plugin:StartDrag().
Fires when the user's mouse leaves a PluginGui during a drag operation started by Plugin:StartDrag().
Fires when the user's mouse moves within a PluginGui during a drag operation started by Plugin:StartDrag().
Fires when the user stops interacting with the window of the PluginGui.
Fires when the user begins interacting with the window of the PluginGui.
- SelectionChanged(amISelected: bool,previousSelection: GuiObject,newSelection: GuiObject):RBXScriptSignal
Fires when the gamepad selection moves to, leaves, or changes within the connected GuiBase2d or any descendent GuiObjects.
Properties
HostWidgetWasRestored
Describes whether the previous state of this DockWidgetPluginGui was restored when it was created.