PanelComponent

Methods
9
Fields
None

Getting one

PanelComponent.new()
OverlayPanel.new(…).panelComponent
OverlayPanel.new(…):getPanelComponent()

Methods

MethodReturnsDescription
getChildren(){LayoutableRenderableEntity}getChildren(): the live list of children, a Luau array: table.insert adds, table.clear clears.
getPreferredSize()Dimension?getPreferredSize().
setBackgroundColor(Color?)()setBackgroundColor(color): nil draws no background.
getBackgroundColor()Color?getBackgroundColor().
setOrientation(ComponentOrientation?)()setOrientation(orientation).
setWrap(boolean)()setWrap(wrap): start a new column (row) once the preferred height (width) is reached.
setBorder(Rectangle?)()setBorder(border): the left, top, right and bottom padding, as a Rectangle's x, y, width and height.
setGap(Point?)()setGap(gap): the space between children.
new()PanelComponentPanelComponent.new(): vertical, STANDARD_WIDTH wide, 4 px border, no gap.

Returned by

MethodReturnsDescription
OverlayPanel.getPanelComponentPanelComponentpanelComponent.
PanelComponentClass.newPanelComponentPanelComponent.new(): vertical, STANDARD_WIDTH wide, 4 px border, no gap.

Method details

setWrap

setWrap: (PanelComponent, boolean) -> ()

setWrap(wrap): start a new column (row) once the preferred height (width) is reached.

new

new: () -> PanelComponent

PanelComponent.new(): vertical, STANDARD_WIDTH wide, 4 px border, no gap.