Class Border

A colored border (and background) around another widget

Hierarchy

Widget
- Border

Index

Methods

Methods

getChild

getChild(): Widget | undefined

- Defined in index.d.ts:2909
Return the child widget. Returns undefined if no child has been set for this border

Returns Widget | undefined

getColor

getColor(): Color

- Defined in index.d.ts:2905
Return the current background color

Returns Color

getOwningObject

getOwningObject(): GameObject | undefined

Inherited from Widget.getOwningObject
- Defined in index.d.ts:1818
Return the game object that this UI element is attached to. Returns undefined if the element isn't attached to a game object.

Returns GameObject | undefined

getParent

getParent(): Widget | undefined

Inherited from Widget.getParent
- Defined in index.d.ts:1813
Return the widget that contains this widget, for example a border that wraps a check box. Returns undefined if this object has no parent.

Returns Widget | undefined

isEnabled

isEnabled(): boolean

Inherited from Widget.isEnabled
- Defined in index.d.ts:1808
Return whether the widget is currently enabled (see setEnabled).

Returns boolean

setChild

setChild(child: Widget): Border

- Defined in index.d.ts:2901
Set the child widget

Parameters
- child: Widget
Returns Border

setColor

setColor(color: Color | [r: number, g: number, b: number, a: number]): Border

- Defined in index.d.ts:2897
Set the background color of the border

Parameters
- color: Color | [r: number, g: number, b: number, a: number]
Returns Border

setEnabled

setEnabled(enabled: boolean): this

Inherited from Widget.setEnabled
- Defined in index.d.ts:1804
Set whether the widget is enabled. When a widget is disabled, users can't interact with it and it is greyed out. When a widget that contains other widgets (like VerticalBox) is disabled, all its children behave as if disabled, too. By default, widgets are enabled.

Parameters
- enabled: boolean
  
  Whether to enable the widget.
Returns this