GUI Experimental Features

class arcade.gui.experimental.UIPasswordInput(*, x: float = 0, y: float = 0, width: float = 100, height: float = 24, text: str = '', font_name=('Arial',), font_size: float = 12, text_color: Tuple[int, int, int] | Tuple[int, int, int, int] = (0, 0, 0, 255), multiline=False, caret_color: Tuple[int, int, int] | Tuple[int, int, int, int] = (0, 0, 0, 255), size_hint=None, size_hint_min=None, size_hint_max=None, **kwargs)

Bases: UIInputText

A password input field. The text is hidden with asterisks.

do_render(surface: Surface)

on_event(event: UIEvent) → bool | None

class arcade.gui.experimental.UIScrollArea(*, x: float = 0, y: float = 0, width: float = 300, height: float = 300, children: Iterable[UIWidget] = (), size_hint=None, size_hint_min=None, size_hint_max=None, canvas_size=(300, 300), **kwargs)

Bases: UIWidget

A widget that can scroll its children.

do_render(surface: Surface)

on_event(event: UIEvent) → bool | None

remove(child: UIWidget)

invert_scroll = False

scroll_speed = 1.3

scroll_x

An observable property which triggers observers when changed.

    def log_change(instance, value):
        print("Something changed")

    class MyObject:
        name = Property()

    my_obj = MyObject()
    bind(my_obj, "name", log_change)
    unbind(my_obj, "name", log_change)

    my_obj.name = "Hans"
    # > Something changed

:param default: Default value which is returned, if no value set before
:param default_factory: A callable which returns the default value.
                        Will be called with the property and the instance

scroll_y

An observable property which triggers observers when changed.

    def log_change(instance, value):
        print("Something changed")

    class MyObject:
        name = Property()

    my_obj = MyObject()
    bind(my_obj, "name", log_change)
    unbind(my_obj, "name", log_change)

    my_obj.name = "Hans"
    # > Something changed

:param default: Default value which is returned, if no value set before
:param default_factory: A callable which returns the default value.
                        Will be called with the property and the instance