ui.text - Ren'Py Visual Novel Engine

documentation index ◦ reference manual ◦ function index

# ui.text

Function: | ui.text | (label, **properties):

This creates a widget displaying a text label.

label - The text that will be displayed on the screen. It uses font properties. The label can also be a list containing both text strings in widgets, in the case of a widget, the widget is displayed as if it was text of the enclosing font. The height of the area allocated is that of the font, with the width being taked from a render of the widget.

slow - If True, the text will be typed at the screen at a rate determined by the slow_cps property, if set, or the "Text Speed" preference. If None (the default), then it will be typed at a speed determined by the slow_cps property. If False, then it will appear instantly.

slow_speed - If slow is True, then this is the number of cps the text is displayed at, overriding the preference.

slow_done - If not None and slow is True, this is a callback that is called when we're done displaying text on the screen.

## Example

    python:
        # Single-child widget, contains the following ui.vbox
        ui.window()

        # Multiple-child widget - all new widgets following this will be
        # added as children to it, until the next ui.close
        ui.vbox()
        ui.text("To get to the next screen, click the 'Continue' button.")
        ui.close()

documentation index ◦ reference manual ◦ function index