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
553HostWidgetWasRestored: bool
573RequestRaise(): null
inherited from PluginGui
553Title: string
573BindToClose(function: Function = nil): null
462GetRelativeMousePosition(): Vector2
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)
462WindowFocusReleased()
462WindowFocused()
inherited from LayerCollector
553Enabled: bool
553ResetOnSpawn: bool
553ZIndexBehavior: ZIndexBehavior
648GetGuiObjectsAtPosition(x: int, y: int): Instances
462GetLayoutNodeTree(): Dictionary
inherited from GuiBase2d
553AbsolutePosition: Vector2
553AbsoluteRotation: float
553AbsoluteSize: Vector2
553AutoLocalize: bool
553RootLocalizationTable: LocalizationTable
553SelectionBehaviorDown: SelectionBehavior
553SelectionBehaviorLeft: SelectionBehavior
553SelectionBehaviorRight: SelectionBehavior
553SelectionBehaviorUp: SelectionBehavior
553SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(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:CreateDockWidgetPluginGui().

History 11

Members 2

HostWidgetWasRestored

TypeDefault
boolfalse

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 4

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