LuaWidgetControl

This type represents the base for a widget. It is used to create custom widgets that can be dragged around your screen.

You can use this as a base type for any draggable elements for your scripts, such as indicators and watermarks. If you wish to have children controls inside a draggable window, look at LuaPopupControl instead.

This is just a control type, to learn how to create custom controls, see LuaControlProto documentation.

__call

Constructor

Constructs the custom widget.

Arguments

Name	Type	Description
id	ControlID|string	ID.
proto	LuaControlProto	Prototype for this control
position	Vec2	Custom offset
size	Vec2	Custom size

Returns

Type	Description
LuaWidgetControl	Custom widget instance.

Example

local proto = gui.LuaControlProto()

function proto:onRender(contents, _, mi, ma)
  contents:AddRect(draw.Rect(mi, ma), draw.color('#fff'))
end

local widget = gui.LuaWidgetControl('my-widget', proto, draw.Vec2(), draw.Vec2(100, 100)) do
  widget:ToggleVisibility(true)
end

gui.ctx:Add(widget)

---

renderBackground

Field

Type: bool

If set to true, will render the default black and blurred background as other widgets.

---

ToggleVisibility

Method

Toggles the visibility on and off for this widget.

Arguments

Name	Type	Description
visible	boolean	Whether or not the widget is visible.

Returns

Nothing.

Example

widget:ToggleVisibility(true)