Canvas

class UI.Canvas

A canvas for user interface elements. See UI.stock_canvas and UI.add_canvas().

rect_transform: UI.RectTransform

The rect transform for the UI object.

Attribute:

Read-only, cannot be set

Return type:

UI.RectTransform

layout_element: UI.LayoutElement

How much space the UI object asks a layout for.

Attribute:

Read-only, cannot be set

Return type:

UI.LayoutElement

Note

Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.

visible: boolean

Whether the UI object is visible.

Attribute:

Can be read or written

Return type:

boolean

Note

This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.

add_panel([visible = true])

Create a panel within this object.

Parameters:

visible (boolean) – Whether the new panel is visible.

Return type:

UI.Panel

add_text(content[, visible = true])

Add text to this object.

Parameters:

• content (string) – The text.

• visible (boolean) – Whether the text is visible.

Return type:

UI.Text

add_input_field([visible = true])

Add an input field to this object.

Parameters:

visible (boolean) – Whether the input field is visible.

Return type:

UI.InputField

add_button(content[, visible = true])

Add a button to this object.

Parameters:

• content (string) – The label for the button.

• visible (boolean) – Whether the button is visible.

Return type:

UI.Button

add_toggle(content[, visible = true])

Add a toggle to this object.

Parameters:

• content (string) – The label for the toggle.

• visible (boolean) – Whether the toggle is visible.

Return type:

UI.Toggle

add_toggle_group()

Add a toggle group to this object, to make a set of toggles into radio buttons.

Return type:

UI.ToggleGroup

Note

The group is not drawn and does not take up any space. The toggles that belong to it can be added anywhere.

add_slider([vertical = false][, visible = true])

Add a slider to this object.

Parameters:

• vertical (boolean) – Whether the slider runs from bottom to top, rather than from left to right.

• visible (boolean) – Whether the slider is visible.

Return type:

UI.Slider

add_dropdown([visible = true])

Add a dropdown to this object.

Parameters:

visible (boolean) – Whether the dropdown is visible.

Return type:

UI.Dropdown

add_image([visible = true])

Add an image to this object.

Parameters:

visible (boolean) – Whether the image is visible.

Return type:

UI.Image

add_scroll_view([visible = true])

Add a scroll view to this object.

Parameters:

visible (boolean) – Whether the scroll view is visible.

Return type:

UI.ScrollView

remove()

Remove the UI object.