LuaPopupControl

This type represents the base for a popup. It is used to create custom windows that can be dragged and have children elements.

You can use this as a base type for any windows for your scripts, such as custom menus. If you wish to have a simple draggable, look at LuaWidgetControl instead.

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

__call

Constructor

Constructs the custom popup.

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
LuaPopupControl	Custom popup instance.

Example

local proto = gui.LuaControlProto()

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

local popup = gui.LuaPopupControl('my-popup', proto, draw.Vec2(), draw.Vec2(100, 100)) do
  popup:Open()
end

---

allowMove

Field

Type: bool

If set to true, allows the window to be dragged normally.

---

isActionPopup

Field

Type: bool

If set to true, will treat this as an action popup. Action popups are any popups that close if you click outside of them, such as the list on a combo box, or a color picker.

---

Open

Method

This makes the pop up appear once.

Arguments

None.

Returns

Nothing.

Example

popup:Open()

---

Close

Method

This makes the pop up disappear forever.

Popups are meant to be temporary windows and cannot be opened again after closed. Use SetVisible to toggle visibility instead! Using a popup after it has been closed can lead to unexpected behavior.

Arguments

None.

Returns

Nothing.

Example

popup:Close()
popup = nil -- Avoid dangling reference