UI Passthrough

Playground

UI Unavailable (CustomFrame)

Instance variable

Provide the variable name of your GUI instance.

Height (px)

Visible

Control whether the passthrough frame is displayed.

Usage

AddUIPassthrough allows you to place any existing GuiBase2d instance inside the library layout.

Arguments

Groupbox:AddUIPassthrough("CustomUI", {
    Instance = CustomFrame,
})

Arg Idx	Argument Description	Type	Default
1	Index/ID of the UI passthrough element	string	nil
2	UI passthrough configuration table	table	nil

Configuration Table

Prop

Type

Methods

Once created, you can rearrange or update the passthrough using:

SetInstance

Replaces the embedded GUI instance.

Passthrough:SetInstance(newInstance)

Arg Idx	Argument Description	Type	Default
1	GuiBase2d instance to parent	GuiBase2d	nil

SetHeight

Adjusts the allocated height.

Passthrough:SetHeight(height)

Arg Idx	Argument Description	Type	Default
1	Height in pixels	number	nil

SetVisible

Shows or hides the passthrough content.

Passthrough:SetVisible(visible)

Arg Idx	Argument Description	Type	Default
1	Visibility toggle	boolean	nil

Example

local Passthrough = Groupbox:AddUIPassthrough("CustomUI", {
    Instance = CustomViewport,
    Height = 180,
})
 
Passthrough:SetVisible(true)
Passthrough:SetInstance(AnotherFrame)
Passthrough:SetHeight(220)

UI Passthrough

On this page