🖥️ BaseWidget

BaseWidget is the base for all WGUI widget classes.

🦠 Functions

---

SetMouseEnabled

Sets whether or not the mouse should be enabled for this widget.

Widget:SetMouseEnabled(IsEnabled)

Type	Parameter	Description
boolean	IsEnabled

GetMouseEnabled

Returns whether or not the mouse should be enabled for this widget.

— Returns boolean.

local ret = Widget:GetMouseEnabled()

---

SetKeyboardEnabled

Sets whether or not the keyboard should be enabled for this widget.

Widget:SetKeyboardEnabled(IsEnabled)

Type	Parameter	Description
boolean	IsEnabled

GetKeyboardEnabled

Returns whether or not the keyboard should be enabled for this widget.

— Returns boolean.

local ret = Widget:GetKeyboardEnabled()

---

SetForceInputRules

Sets whether or not the widget should force the input rules to be recalculated no matter if it is visible or not.

Widget:SetForceInputRules(Force)

Type	Parameter	Description
boolean	Force

GetForceInputRules

— Returns boolean.

local ret = Widget:GetForceInputRules()

SetTranslation

Sets the render translation of the widget.

Widget:SetTranslation(NewTranslation)

Type	Parameter	Description
Vector2D	NewTranslation

GetTranslation

Gets the render translation of the widget.

— Returns Vector2D.

local ret = Widget:GetTranslation()

---

SetScale

Sets the scale of the widget.

Widget:SetScale(NewScale)

Type	Parameter	Description
Vector2D	NewScale

GetScale

Gets the scale of the widget.

— Returns Vector2D.

local ret = Widget:GetScale()

---

GetDesiredSize

Returns the desired size of the widget.

— Returns Vector2D.

local ret = Widget:GetDesiredSize()

---

SetShear

Sets the shear of the widget.

Widget:SetShear(NewShear)

Type	Parameter	Description
Vector2D	NewShear

GetShear

Gets the shear of the widget.

— Returns Vector2D.

local ret = Widget:GetShear()

---

SetAngle

Sets the angle of the widget.

Widget:SetAngle(NewAngle)

Type	Parameter	Description
number	NewAngle

GetAngle

Gets the angle of the widget.

— Returns number.

local ret = Widget:GetAngle()

---

SetPivot

Sets the pivot of the widget.

Widget:SetPivot(NewPivot)

Type	Parameter	Description
Vector2D	NewPivot

GetPivot

Gets the pivot of the widget.

— Returns Vector2D.

local ret = Widget:GetPivot()

---

SetOpacity

Sets the opacity of the widget.

Widget:SetOpacity(NewOpacity)

Type	Parameter	Description
number	NewOpacity

GetOpacity

Gets the opacity of the widget.

— Returns number.

local ret = Widget:GetOpacity()

---

SetColor

Sets the tint of the widget, this affects all children.

Widget:SetColor(Color)

Type	Parameter	Description
Color	Color

GetColor

Gets the tint of the widget.

— Returns Color.

local ret = Widget:GetColor()

---

SetForegroundColor

Sets the foreground color of the widget.

Widget:SetForegroundColor(Color, ColorRule)

Type	Parameter	Description
Color	Color
ColorMode	ColorRule

CreateAnimationObject

— Returns AnimationObject.

local ret = Widget:CreateAnimationObject(
    GetterFunction,
    SetterFunction,
    EndValue,
    Duration,
    OnCompleted?,
    AutoDestroy?,
    EasingFunction?
)

Type	Name	Default
function	GetterFunction
function	SetterFunction
number | Vector2D	EndValue
number	Duration
function	OnCompleted?
boolean	AutoDestroy?	false
function	EasingFunction?

RemoveFromParent

Removes the widget from its parent panel.

Widget:RemoveFromParent()

---

GetParent

Returns the parent panel of the widget.

— Returns PanelWidget or nil.

local ret = Widget:GetParent()

---

IsChildOfParent

Returns whether the widget is a child of the specified parent class.

— Returns boolean.

local ret = Widget:IsChildOfParent(ParentClass)

Type	Parameter	Description
PanelWidget	ParentClass

SetVisibility

Sets the visibility of the widget.

Widget:SetVisibility(NewVisibility)

Type	Parameter	Description
WGUIVisibility	NewVisibility

GetVisibility

Gets the visibility of the widget.

— Returns WGUIVisibility.

local ret = widget:GetVisibility()

---

IsVisible

Returns true if the widget is currently visible.

— Returns boolean.

local ret = Widget:IsVisible()

---

IsHitTestable

Returns true if the widget can be interacted with.

— Returns boolean.

local ret = Widget:IsHitTestable()

---

IsHovered

Returns true if the widget is currently being hovered.

— Returns boolean.

local ret = Widget:IsHovered()

---

IsRendered

Returns true if the widget is currently rendered.

— Returns boolean.

local ret = Widget:IsRendered()

---

SetIsEnabled

Sets the current enabled status of the widget.

Widget:SetIsEnabled(IsEnabled)

Type	Parameter	Description
boolean	IsEnabled

GetIsEnabled

Gets the current enabled status of the widget.

— Returns boolean.

local ret = Widget:GetIsEnabled()

---

SetPadding

Sets the padding of the widget, putting a larger gap between the widget border and it's root widget.

widget:SetPadding(Padding)

Type	Parameter	Description
Margin, number	Padding

GetPadding

Gets the padding of the widget.

— Returns Margin.

local ret = widget:GetPadding()

---

SetToolTipText

Sets the tooltip text of the widget.

Widget:SetToolTipText(Text)

Type	Parameter	Description
string	Text

GetToolTipText

Gets the tooltip text of the widget.

— Returns string.

local ret = Widget:GetToolTipText()

---

SetToolTipWidget

Sets the tooltip widget of the widget.

Widget:SetToolTipWidget(Widget)

Type	Parameter	Description
Widget	Widget

GetToolTipWidget

Gets the tooltip widget of the widget.

— Returns Widget

local ret = Widget:GetToolTipWidget()

---

SetCursor

Sets the cursor to show over the widget.

widget:SetCursor(Cursor)

Type	Parameter	Description
CursorType	Cursor

GetCursor

Gets the cursor to show over the widget.

— Returns CursorType.

local ret = Widget:GetCursor()

---

SetClipping

Sets the clipping state of the widget.

widget:SetClipping(Clipping)

Type	Parameter	Description
WidgetClipping	Clipping

GetClipping

Gets the clipping state of the widget.

— Returns WidgetClipping.

local ret = Widget:GetClipping()

---

SetSnapToPixel

Sets whether or not the widget will draw snapped to the nearest pixel.

Widget:SetSnapToPixel(PixelSnapping)

Type	Parameter	Description
PixelSnapping	PixelSnapping

GetSnapToPixel

Gets whether or not the widget will draw snapped to the nearest pixel.

— Returns PixelSnapping.

local ret = Widget:GetSnapToPixel()

---

SetDragKey

Sets the input key that will be used to drag the widget.

Widget:SetDragKey(Key)

Type	Parameter	Description
string	Key

GetDragKey

Gets the input key that will be used to drag the widget.

— Returns string.

local ret = Widget:GetDragKey()

---

CreateDragDropOperation

Creates a new drag & drop operation. Should be called inside a OnDragDetected event.

Widget:CreateDragDropOperation(DragVisual, Payload, MetaData, Pivot, Offset)

Type	Parameter	Description
BaseWidget	DragVisual
BaseWidget	Payload
string	MetaData
DragPivot	Pivot
Vector2D	Offset

CancelDragDropOperation

Cancels any ongoing drag & drop operation.

Widget:CancelDragDropOperation()

---

GetIsDragDropping

Returns true if the widget is currently being dragged.

— Returns boolean.

local ret = Widget:GetIsDragDropping()

---

InvalidateLayoutAndVolatility

Invalidates the widget from the view of a layout caching widget that may own this widget. It will force the owning widget to redraw and cache children on the next paint pass.

Widget:InvalidateLayoutAndVolatility()

---

ForceVolatile

Sets the forced volatility of the widget.

Widget:ForceVolatile(bForce)

Type	Parameter	Description
boolean	bForce

ForceLayoutPrepass

Forces a pre-pass. A pre-pass caches the desired size of the widget hierarchy owned by this widget.

Widget:ForceLayoutPrepass()

---

BindDispatcher

— Returns function (the subscribed callback itself).

local ret = Widget:BindDispatcher(EventName, Callback)

Type	Parameter	Description
string	EventName
function	Callback

UnbindDispatcher

Widget:UnbindDispatcher(EventName, Callback?)

Type	Parameter	Description
string	EventName
function	Callback?

---

🚀 Events

Mouse Button Down

Widget:BindDispatcher("MouseButtonDown", function(self, PointerEvent)
    -- Mouse Button Down was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Mouse Button Up

Widget:BindDispatcher("MouseButtonUp", function(self, PointerEvent)
    -- Mouse Button Up was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Mouse Move

Widget:BindDispatcher("MouseButtonMove", function(self, PointerEvent)
    -- Mouse Button Move was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Mouse Enter

Widget:BindDispatcher("MouseEnter", function(self, PointerEvent)
    -- Mouse Enter was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Mouse Leave

Widget:BindDispatcher("MouseLeave", function(self, PointerEvent)
    -- Mouse Leave was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Mouse Wheel

Widget:BindDispatcher("MouseWheel", function(self, PointerEvent)
    -- Mouse Wheel was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Mouse Double Click

Widget:BindDispatcher("MouseDoubleClick", function(self, PointerEvent)
    -- Mouse Double Click was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Focus Received

Widget:BindDispatcher("FocusReceived", function()
    -- Focus Received was called
end)

Focus Lost

Widget:BindDispatcher("FocusLost", function()
    -- Focus Lost was called
end)

Drag Detected

Widget:BindDispatcher("DragDetected", function(self, PointerEvent)
    -- Drag Detected was called
end)

Type	Parameter	Description
PointerEvent	PointerEvent

Drag Cancelled

Widget:BindDispatcher("DragCancelled", function(self, PointerEvent)
    -- Drag Cancelled was called
end)

Type	Parameter	Description
integer	PayloadID
string	Tag

Drop

Widget:BindDispatcher("Drop", function(self, PayloadID, Tag)
    -- Drop was called
end)

Type	Parameter	Description
integer	PayloadID
string	Tag