renpy.movie cutscene - Ren'Py Visual Novel Engine

documentation index ◦ reference manual ◦ function index

# renpy.movie_cutscene

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

This displays a fullscreen movie cutscene.

filename - The name of a file containing a 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.

stop_music - If True, stops the music channel while the cutscene is playing, and starts it again when the cutscene is over.

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

## Example

    e "Why not watch a movie?"

    $ renpy.movie_cutscene('superman.avi')

documentation index ◦ reference manual ◦ function index