documentation index ◦ reference manual ◦ function index

# renpy.get_roll_forward

Function: | renpy.get_roll_forward | ():

Gets the roll forward info for the current interaction. This function is intended to be used by overlay functions. The overlay function should return the result of this function to cause a roll-forward to happen.

Note that it only makes sense to use this inside of an interaction. See renpy.roll_forward_info for information on how to get the roll forward info outside of an interaction.

    init python hide:
        def overlay():
            value = renpy.get_roll_forward()
            if value is not None:
                ui.textbutton("->", clicked=ui.returns(value), xalign=1.0, yalign=1.0)

        config.overlay_functions.append(overlay)

documentation index ◦ reference manual ◦ function index