Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Canvas

A widget that can contain other widgets at fixed coordinates. A canvas has no size of its own, so you need to explicitly set the widget size in the UIElement when using it. Widget coordinates are in pixels, at default scale one pixel corresponds to 1 mm in the game world.

Hierarchy

Index

Methods

addChild

  • addChild(child: Widget, x: number, y: number, width: number, height: number): Canvas
  • Add a child widget to the canvas.

    Parameters

    • child: Widget

      The widget to add

    • x: number

      The X coordinate in pixels

    • y: number

      The Y coordinate in pixels

    • width: number

      Width of the widget on the canvas in pixels

    • height: number

      Height of the widget on the canvas in pixels

    Returns Canvas

getOwningObject

getParent

  • getParent(): Widget | undefined
  • 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

removeChild

  • removeChild(child: Widget): void
  • Remove the given child from the canvas

    Parameters

    • child: Widget

      The widget to remove

    Returns void

setEnabled

  • setEnabled(enabled: boolean): Widget
  • 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 Widget