QWidgetPluginGui

Properties

• Title:string

  Read Parallel

  The title that is displayed above the contents of the PluginGui.

• Enabled:bool

  Read Parallel

  Toggles the visibility of this LayerCollector.

• ResetOnSpawn:bool

  Read Parallel

  Determines if the LayerCollector resets (deletes itself and re-clones into the player's PlayerGui) every time the player's character respawns.

• ZIndexBehavior:Enum.ZIndexBehavior

  Read Parallel

  Controls how GuiObject.ZIndex behaves on all descendants of this LayerCollector.

• AbsolutePosition:Vector2

  Read Only

  Not Replicated

  Describes the actual screen position of a UI element, in pixels.

• AbsoluteRotation:number

  Read Only

  Not Replicated

  Describes the actual screen rotation of a UI element, in degrees.

• AbsoluteSize:Vector2

  Read Only

  Not Replicated

  Describes the actual screen size of a UI element, in pixels.

• AutoLocalize:bool

  Read Parallel

  When set to true, localization will be applied to this GuiBase2d and its descendants.

• RootLocalizationTable:LocalizationTable

  Read Parallel

  A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.

• SelectionBehaviorDown:Enum.SelectionBehavior

  Read Parallel

  Customizes gamepad selection behavior in the down direction.

• SelectionBehaviorLeft:Enum.SelectionBehavior

  Read Parallel

  Customizes gamepad selection behavior in the left direction.

• SelectionBehaviorRight:Enum.SelectionBehavior

  Read Parallel

  Customizes gamepad selection behavior in the right direction.

• SelectionBehaviorUp:Enum.SelectionBehavior

  Read Parallel

  Customizes gamepad selection behavior in the up direction.

• SelectionGroup:bool

  Read Parallel

  Allows customization of gamepad selection movement.

Methods

• BindToClose(function : function):void

  Binds a function to the PluginGui close button, overriding the default behavior.

• GetRelativeMousePosition():Vector2

  Plugin Security

  Returns the position of the mouse relative to the PluginGui.

Events

• PluginDragDropped(dragData : Dictionary):RBXScriptSignal

  Plugin Security

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

• PluginDragEntered(dragData : Dictionary):RBXScriptSignal

  Plugin Security

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

• PluginDragLeft(dragData : Dictionary):RBXScriptSignal

  Plugin Security

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

• PluginDragMoved(dragData : Dictionary):RBXScriptSignal

  Plugin Security

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

• WindowFocusReleased():RBXScriptSignal

  Plugin Security

  Fires when the user stops interacting with the window of the PluginGui.

• WindowFocused():RBXScriptSignal

  Plugin Security

  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 descendant GuiObjects.