FolioTier 2

video

Play or stop a cutscene clip — one-shot or looping.

Parameters

ParameterKindRequiredDefaultNotes
actionidentifieryesOne of `play` or `stop`. `play` starts a cutscene clip; `stop` halts the currently-playing video.
referenceidentifiernoVideo reference registered in the project's video assets. Required for `play`; omit for `stop`. Quoted form accepted for references with non-identifier characters.
loopbooleannofalseTrailing `loop` flag — the clip plays continuously until a `video stop` or scene transition. Maps from Ren'Py's `loops=-1`. Omit for one-shot playback.

Canonical example

Folio
video play denjiwork
video play powerdans loop
video stop
Ren'Py
$ renpy.movie_cutscene("video/denjiwork.webm", loops=0)
$ renpy.movie_cutscene("video/powerdans.webm", loops=-1)

video plays a cutscene clip in the player's video overlay. One-shot clips advance to the next step when they finish; the loop flag keeps the clip running until a video stop or a scene transition ends it.

Notes

The Ren'Py $ renpy.movie_cutscene("…") Python call lowers to this verb during import. loops=0 becomes video play <ref>; loops=-1 becomes video play <ref> loop. Authors editing imported scripts should never see the original Python — the importer rewrites it before the script reaches the editor.

Looping playback works with overlay dialogue: a scene that plays a looped video and then runs say lines renders the dialogue on top of the video. End the loop with video stop or change scenes with scene <bg>.

See also

  • scene — for video-backed scene backgrounds (the Movie(...) displayable pattern); use scene when the video is a layered background, video when it's a foreground cutscene
  • sound — same action grammar applied to SFX