Package-level declarations

Types

Link copied to clipboard
abstract class BaseButton : Control

The abstract base for different buttons. Other types of buttons inherit from this.

Link copied to clipboard
abstract class BoxContainer : Container

A Container that handles both vertical and horizontal alignments of its children.

Link copied to clipboard
open class Button : BaseButton
Link copied to clipboard
Link copied to clipboard

A Container that centers any children within it.

Link copied to clipboard
open class Container : Control

A Control node that all containers inherit from.

Link copied to clipboard
open class Control : CanvasItem

The base Node for deriving ui element nodes. Handles size changes, anchoring, and margins.

Link copied to clipboard

A Container node that holds a FrameBufferNode. It uses the FrameBufferNode minimum size unless stretch is enabled.

Link copied to clipboard

A vertical BoxContainer by adding Control from left to right.

Link copied to clipboard
open class HScrollBar : ScrollBar

A horizontal ScrollBar which goes left min to right max.

Link copied to clipboard
open class Label : Control

A Control that renders text with a specified BitmapFont.

Link copied to clipboard
open class LineEdit : Control

A Control that renders and single line of editable text.

Link copied to clipboard
open class NinePatchRect : Control

Creates a Control that uses and renders a NinePatch.

Link copied to clipboard

A Container with padding.

Link copied to clipboard
open class Panel : Control

A Control that provides an opaque background.

Link copied to clipboard

A Container that fits controls inside the area of the Drawable.

Link copied to clipboard
open class ProgressBar : Range

General-purpose progress bar. Shows fill percentage from right to left.

Link copied to clipboard
abstract class Range : Control
Link copied to clipboard
abstract class ScrollBar(val orientation: Orientation = Orientation.VERTICAL) : Range

A abstract Range-based Control that displays a draggable area (page). See HScrollBar or VScrollBar in order to use it.

Link copied to clipboard

A Container node that will automatically create a ScrollBar child (HScrollBar or VScrollBar, or both) when needed.

Link copied to clipboard
open class TextureProgress : Range

A textured-based progress bar. Useful for loading screens and health bars.

Link copied to clipboard
open class TextureRect : Control

A Control node that display a TextureSlice.

Link copied to clipboard

A vertical BoxContainer by adding Control from bottom up.

Link copied to clipboard
open class VScrollBar : ScrollBar

A vertical ScrollBar which goes top min to bottom max.

Functions

Link copied to clipboard
inline fun SceneGraph<*>.button(callback: Button.() -> Unit = {}): Button

Adds a Button to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.button(callback: Button.() -> Unit = {}): Button

Adds a Button to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.centerContainer(callback: CenterContainer.() -> Unit = {}): CenterContainer

Adds a CenterContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.centerContainer(callback: CenterContainer.() -> Unit = {}): CenterContainer

Adds a CenterContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.column(callback: VBoxContainer.() -> Unit = {}): VBoxContainer

Adds a VBoxContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.column(callback: VBoxContainer.() -> Unit = {}): VBoxContainer

Adds a VBoxContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.container(callback: Container.() -> Unit = {}): Container

Adds a Container to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.container(callback: Container.() -> Unit = {}): Container

Adds a Container to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.control(callback: Control.() -> Unit = {}): Control

Adds a Control to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.control(callback: Control.() -> Unit = {}): Control

Adds a Control to the current Node as a child and then triggers the callback

Link copied to clipboard

Adds a FrameBufferContainer to the current SceneGraph.root as a child and then triggers the callback

Adds a FrameBufferContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.hBoxContainer(callback: HBoxContainer.() -> Unit = {}): HBoxContainer

Adds a HBoxContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.hBoxContainer(callback: HBoxContainer.() -> Unit = {}): HBoxContainer

Adds a HBoxContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.hScrollBar(callback: HScrollBar.() -> Unit = {}): HScrollBar

Adds a HScrollBar to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.hScrollBar(callback: HScrollBar.() -> Unit = {}): HScrollBar

Adds a HScrollBar to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.label(callback: Label.() -> Unit = {}): Label

Adds a Label to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.label(callback: Label.() -> Unit = {}): Label

Adds a Label to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.lineEdit(callback: LineEdit.() -> Unit = {}): LineEdit

Adds a LineEdit to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.lineEdit(callback: LineEdit.() -> Unit = {}): LineEdit

Adds a LineEdit to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.ninePatchRect(callback: NinePatchRect.() -> Unit = {}): NinePatchRect

Adds a NinePatchRect to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.ninePatchRect(callback: NinePatchRect.() -> Unit = {}): NinePatchRect

Adds a NinePatchRect to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.paddedContainer(callback: PaddedContainer.() -> Unit = {}): PaddedContainer

Adds a PaddedContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.paddedContainer(callback: PaddedContainer.() -> Unit = {}): PaddedContainer

Adds a PaddedContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.panel(callback: Panel.() -> Unit = {}): Panel

Adds a Panel to the SceneGraph.root as a child and then triggers the callback

inline fun Node.panel(callback: Panel.() -> Unit = {}): Panel

Adds a Panel to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.panelContainer(callback: PanelContainer.() -> Unit = {}): PanelContainer

Adds a PanelContainer to the SceneGraph.root as a child and then triggers the callback

inline fun Node.panelContainer(callback: PanelContainer.() -> Unit = {}): PanelContainer

Adds a PanelContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.progressBar(callback: ProgressBar.() -> Unit = {}): ProgressBar

Adds a ProgressBar to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.progressBar(callback: ProgressBar.() -> Unit = {}): ProgressBar

Adds a ProgressBar to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.row(callback: HBoxContainer.() -> Unit = {}): HBoxContainer

Adds a HBoxContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.row(callback: HBoxContainer.() -> Unit = {}): HBoxContainer

Adds a HBoxContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.scrollContainer(callback: ScrollContainer.() -> Unit = {}): ScrollContainer

Adds a ScrollContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.scrollContainer(callback: ScrollContainer.() -> Unit = {}): ScrollContainer

Adds a ScrollContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.textureProgress(callback: TextureProgress.() -> Unit = {}): TextureProgress

Adds a TextureProgress to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.textureProgress(callback: TextureProgress.() -> Unit = {}): TextureProgress

Adds a TextureProgress to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.textureRect(callback: TextureRect.() -> Unit = {}): TextureRect

Adds a TextureRect to the SceneGraph.root as a child and then triggers the callback

inline fun Node.textureRect(callback: TextureRect.() -> Unit = {}): TextureRect

Adds a TextureRect to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.vBoxContainer(callback: VBoxContainer.() -> Unit = {}): VBoxContainer

Adds a VBoxContainer to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.vBoxContainer(callback: VBoxContainer.() -> Unit = {}): VBoxContainer

Adds a VBoxContainer to the current Node as a child and then triggers the callback

Link copied to clipboard
inline fun SceneGraph<*>.vScrollBar(callback: VScrollBar.() -> Unit = {}): VScrollBar

Adds a VScrollBar to the current SceneGraph.root as a child and then triggers the callback

inline fun Node.vScrollBar(callback: VScrollBar.() -> Unit = {}): VScrollBar

Adds a VScrollBar to the current Node as a child and then triggers the callback