Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DockWidgetPluginGui

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Tags: [NotCreatable, NotReplicated]

Member index 2

HistoryMember
726HostWidgetWasRestored: bool
573RequestRaise(): null
inherited from PluginGui
726Title: string
573BindToClose(function: Function = nil): null
462GetRelativeMousePosition(): Vector2
725OverrideStudioAction(studioAction: StudioAction): StudioActionOverride
651InputBegan(input: InputObject, gameProcessedEvent: bool)
651InputChanged(input: InputObject, gameProcessedEvent: bool)
651InputEnded(input: InputObject, gameProcessedEvent: bool)
651MouseEnter()
651MouseLeave()
462PluginDragDropped(dragData: Dictionary)
462PluginDragEntered(dragData: Dictionary)
462PluginDragLeft(dragData: Dictionary)
462PluginDragMoved(dragData: Dictionary)
711PointerAction(wheel: float, pan: Vector2, pinch: float, gameProcessedEvent: bool)
462WindowFocusReleased()
462WindowFocused()
inherited from LayerCollector
726Enabled: bool
726ResetOnSpawn: bool
726ZIndexBehavior: ZIndexBehavior
648GetGuiObjectsAtPosition(x: int, y: int): Instances
462GetLayoutNodeTree(): Dictionary
inherited from GuiBase2d
726AbsolutePosition: Vector2
726AbsoluteRotation: float
726AbsoluteSize: Vector2
726AutoLocalize: bool
726RootLocalizationTable: LocalizationTable
726SelectionBehaviorDown: SelectionBehavior
726SelectionBehaviorLeft: SelectionBehavior
726SelectionBehaviorRight: SelectionBehavior
726SelectionBehaviorUp: SelectionBehavior
726SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 2

HistoryMember
354WindowFocusReleased()
354WindowFocused()

Description

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:CreateDockWidgetPluginGuiAsync().

History 12

Members 2

HostWidgetWasRestored

TypeDefault
bool

Describes whether the previous state of this DockWidgetPluginGui was restored when it was created.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 5

Tags: [ReadOnly, NotReplicated]

RequestRaise

Parameters (0)
No parameters.
Returns (1)
null

History 2

Removed members 2

WindowFocusReleased

Parameters (0)
No parameters.

History 2

WindowFocused

Parameters (0)
No parameters.

History 2

Settings