renpy.display menu - Ren'Py Visual Novel Engine

documentation index ◦ reference manual ◦ function index

# renpy.display_menu

Function: | renpy.display_menu | (items, window_style='menu_window', interact=True, with_none=None):

Displays a menu containing the given items, returning the value of the item the user selects.

items - A list of tuples that are the items to be added to this menu. The first element of a tuple is a string that is used for this menuitem. The second element is the value to be returned if this item is selected, or None if this item is a non-selectable caption.

interact - If True, then an interaction occurs. If False, no such interaction occurs, and the user should call ui.interact manually.

with_none - If True, causes a "with None" statement to be run after each interaction. If None (the default), checks config.implicit_with_none to determine if a "with None" should be run.

## Example

    python:
        test = [
            ("unselectable item", None),
            ]
        test.append(["value shown","returned value"])
        result = renpy.display_menu(test)

documentation index ◦ reference manual ◦ function index