OverlayPanel

Extends
Overlay
Methods
9
Fields
1

Getting one

OverlayPanel.new(…)

Methods

MethodReturnsDescription
getPanelComponent()PanelComponentpanelComponent.
isClearChildren()booleanWhether render empties the panel's children (default true).
setClearChildren(boolean)()Whether render empties the panel's children.
isDynamicFont()booleanWhether the font follows the resized width (default false).
setDynamicFont(boolean)()Whether the font follows the resized width.
getPreferredColor()Color?The background used instead of the standard one, or nil.
setPreferredColor(Color?)()The background used instead of the standard one, or nil.
isInstance(any)booleanWhether obj is an instance of this class or a subclass of it, as made with class.
new(any?)OverlayPanel() -> OverlayPanel: An Overlay with a new PanelComponent, resizable. A subclass's new runs it first.

Fields

FieldTypeDescription
panelComponentPanelComponentThe panel render draws.

Returned by

MethodReturnsDescription
OverlayPanelClass.newOverlayPanel() -> OverlayPanel: An Overlay with a new PanelComponent, resizable. A subclass's new runs it first.

Method details

isInstance

isInstance: (any) -> boolean

Whether obj is an instance of this class or a subclass of it, as made with class.

new

new: (any?) -> OverlayPanel

() -> OverlayPanel: An Overlay with a new PanelComponent, resizable. A subclass's new runs it first.

(any?) -> OverlayPanel: As new(); the plugin is the caller's to keep, as with Overlay.