renpy.pause - Ren'Py

documentation index ◦ reference manual ◦ function index

# renpy.pause

Function: | renpy.pause | (delay=None, music=None):

When called with no arguments, this pauses and waits for the user to click before advancing the script. If given a delay parameter, then Ren'Py will wait for that amount of time before continuing, unless a user clicks to interrupt the delay. This is useful to, for instance, show an image that will stay on screen for a certain amount of time and then proceed to the next script statement without waiting for a click forever.

delay - The number of seconds to delay.

music - If supplied, and music is playing, this takes precedence over the delay parameter. It gives a time, in seconds, into the currently playing music track. Ren'Py will pause until the music has played up to that point.

Returns True if the pause was interrupted by the user hitting a key or clicking a mouse, or False if the pause was ended by the appointed time being reached.

## Example

    scene black
    show text "American Bishoujo Presents..." with dissolve
    $ renpy.pause(1.0)
    hide text with dissolve

TODO: music pause example.

documentation index ◦ reference manual ◦ function index