renpy.movie cutscene - Ren'Py

documentation index ◦ reference manual ◦ function index

# renpy.movie_cutscene

Function: | renpy.movie_cutscene | (filename, delay=None, loops=0):

This displays an MPEG-1 cutscene for the specified number of seconds. The user can click to interrupt the cutscene. Overlays and Underlays are disabled for the duration of the cutscene.

filename - The name of a file containing an MPEG-1 movie.

delay - The number of seconds to wait before ending the cutscene. Normally the length of the movie, in seconds. If None, the length of the movie will be automatically determined. If -1, the cutscene will not automatically terminate, and will continue until the user clicks.

loops - The number of extra loops to show, -1 to loop forever.

Returns True if the movie was terminated by the user, or False if the given delay elapsed uninterrupted.

## Example

    e "Since you downloaded the Eisenhower commercial, I can show
       it to you as a cutscene."

    e "You can click to continue if it gets on your nerves too
                       much."

    $ renpy.movie_cutscene('Eisenhow1952.mpg', 63.0)

documentation index ◦ reference manual ◦ function index