Widget-Wrapper

A simple, type safe and minimalistic wrapper of Roblox Studio DockWidgetPluginGui Its fully O(1) complexity.

Example

for all the methods head to Methods

local Widget = require(script.Parent.widget)

local widget = Widget.new(plugin, {
  id = "Widget",
  title = "Widget",
  state = Enum.InitialDockState.Float,
  size = Vector2.new(250, 250),
  min_size = Vector2.new(100, 100),
  enabled = true,
  restore = true,
})

local frame = Instance.new("Frame")
local text_label = Instance.new("TextLabel")

widget:mount(frame, text_label) -- add instances to the widget
widget:unmount(frame, text_label) -- remove instances from the widget
widget:clear() -- destroy all instances parented to the widget

Methods

• new(plugin, props) -> class constructor
• destroy() -> destroy the widget
• show() -> show the widget
• hide() -> hide the widget
• visible() -> returns if the widget is visible
• set_title(title) -> updates the current widget title
• get() -> returns the DockWidgetPluginGui itself
• clear() -> removes every Instance parented to the DockWidgetPluginGui
• mount(...) -> parents every Instance given to the DockWidgetPluginGui
• unmount(...) -> destroy every Instance given thats parented to the DockWidgetPluginGui

Props

this are the props you can pass to the constructor

• id: string? -> unique plugin id
• title: string? -> widget title
• state: Enum.InitialDockState? -> default dock state
• size: Vector2? -> default widget size in pixels
• min_size: Vector2? -> minimal size for the widget in pixels

Warning

Minimum widget size does not work since roblox decided to update docking system.

• enabled: boolean? -> default visibility
• restore: boolean? -> if true, will override any saved enabled state with the state value.