Return all child widgets of the canvas
Return the game object that this UI element is attached to. Returns undefined if the element isn't attached to a game object.
Return the widget that contains this widget, for example a border that wraps a check box. Returns undefined if this object has no parent.
Return whether the widget is currently enabled (see setEnabled).
Return whether the widget is currently visible (see setVisible).
Remove the given child from the canvas
The widget to remove
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.
Whether to enable the widget.
Set whether the widget is visible. When a widget that contains other widgets (like VerticalBox) is invisible, all its children are invisible, too. The layout of widgets is updated when visibility changes, and invisible widgets are treated as if they don't exist.
Whether the widget is visible.
Update coordinates of a child widget of the canvas. Will not do anything if called with a widget that is not a child of the canvas.
The widget to add
The X coordinate in pixels. Can be undefined to keep the current X coordinate.
The Y coordinate in pixels. Can be undefined to keep the current Y coordinate.
Width of the widget on the canvas in pixels. Can be undefined to keep the current width.
Height of the widget on the canvas in pixels. Can be undefined to keep the current height.
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 and set UIElement.useWidgetSize to false when using it. Widget coordinates are in pixels, at default scale one pixel corresponds to 1 mm in the game world.
Usually you'll use a Canvas as the top widget in a UIElement or ScreenUIElement, but you can also use it as a child of other widgets. In particular, using a Canvas inside of a LayoutBox with an override size inside of a layout where widget size is automatic (for example in a VerticalBox) can be useful.