RegisterPopupGui

What it does

Registers a popup GUI so XLQP can coordinate its lifecycle and visibility.

When to use it

Use it for custom popups that need to behave consistently with built-in overlays.

XLQPGen1:RegisterPopupGui(gui)

local Result = Library:RegisterPopupGui(
    ScreenGui,
)

Behavior and return value

Registration connects an existing object or definition to XLQP. Register it after the object exists and before relying on XLQP-managed behavior.

Fields marked optional may be omitted. XLQP then uses the method’s built-in default or leaves that feature disabled.

Related reference

• All element options
• Controller methods
• Full example