/usr/share/doc/renpy/html/movie.html is in renpy-doc 6.17.6-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 | <!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Movie — Ren'Py Documentation</title>
<link rel="stylesheet" href="_static/screen.css" type="text/css" media="screen, projection"/>
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" media="print" />
<!--[if lt IE 8]>
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" media="screen, projection"/>
<![endif]-->
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '6.18.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Ren'Py Documentation" href="index.html" />
<link rel="next" title="Voice" href="voice.html" />
<link rel="prev" title="Audio" href="audio.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="voice.html" title="Voice"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="audio.html" title="Audio"
accesskey="P">previous</a> |</li>
<li> <img src="_static/logo.png" width=19 height=21 align=center>
<li> <a href="http://www.renpy.org/">Ren'Py Home</a> |
<li><a href="index.html">Ren'Py Documentation</a></li>
</ul>
</div>
<div class="container">
<div class="span4">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Movie</a><ul>
<li><a class="reference internal" href="#fullscreen-movies">Fullscreen Movies</a></li>
<li><a class="reference internal" href="#movies-inside-displayables">Movies Inside Displayables</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="audio.html"
title="previous chapter">Audio</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="voice.html"
title="next chapter">Voice</a></p>
<h4>Search</h4>
<div id="cse-search-form" style="width: 100%;"></div>
<div class="copydata">
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
<br>
</div>
</div>
</div>
</div>
<div class="document span20 last">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="movie">
<h1>Movie<a class="headerlink" href="#movie" title="Permalink to this headline">¶</a></h1>
<p>Ren'Py is capable of using libav (included) to play movies using the
video codecs:</p>
<ul class="simple">
<li>Theora</li>
<li>V8</li>
<li>MPEG 4 part 2 (including Xvid and DivX)</li>
<li>MPEG 2</li>
<li>MPEG 1</li>
</ul>
<p>and the following audio codecs:</p>
<ul class="simple">
<li>Vorbis</li>
<li>MP3</li>
<li>MP2</li>
<li>PCM</li>
</ul>
<p>inside the following container formats:</p>
<ul class="simple">
<li>Matroska</li>
<li>WebM</li>
<li>Ogg</li>
<li>Avi</li>
<li>Various kinds of MPEG stream.</li>
</ul>
<p>(Note that using some of these formats may require patent licenses.
When in doubt, and especially for commercial games, we recommend using
Theora, Vorbis, and Matroska or Ogg.)</p>
<p>Ren'Py expects that every movie will have an audio track associated with it,
even if that audio track consists of nothing but silence. This is because
the audio track is used for synchronization purposes.</p>
<p>Movies can be displayed fullscreen, or in a displayable. Fullscreen movies
are the more efficient.</p>
<div class="section" id="fullscreen-movies">
<h2>Fullscreen Movies<a class="headerlink" href="#fullscreen-movies" title="Permalink to this headline">¶</a></h2>
<p>The easiest way to display a movie fullscreen is to display it using
the <a class="reference internal" href="#renpy.movie_cutscene" title="renpy.movie_cutscene"><tt class="xref py py-func docutils literal"><span class="pre">renpy.movie_cutscene()</span></tt></a> function. This function displays a movie for a specified
length of time. When that time has elapsed, or when the user clicks to dismiss
the movie, the movie ends and the function returns.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">$</span> <span class="n">renpy</span><span class="o">.</span><span class="n">movie_cutscene</span><span class="p">(</span><span class="s">"On_Your_Mark.mpg"</span><span class="p">)</span>
</pre></div>
</div>
<dl class="function">
<dt id="renpy.movie_cutscene">
<tt class="descclassname">renpy.</tt><tt class="descname">movie_cutscene</tt><big>(</big><em>filename</em>, <em>delay=None</em>, <em>loops=0</em>, <em>stop_music=True</em><big>)</big><a class="headerlink" href="#renpy.movie_cutscene" title="Permalink to this definition">¶</a></dt>
<dd><p>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.</p>
<dl class="docutils">
<dt><cite>filename</cite></dt>
<dd>The name of a file containing an MPEG-1 movie.</dd>
<dt><cite>delay</cite></dt>
<dd>The number of seconds to wait before ending the cutscene.
Normally the length of the movie, in seconds. If None, then the
delay is computed from the number of loops (that is, loops + 1) *
the length of the movie. If -1, we wait until the user clicks.</dd>
<dt><cite>loops</cite></dt>
<dd>The number of extra loops to show, -1 to loop forever.</dd>
</dl>
<p>Returns True if the movie was terminated by the user, or False if the
given delay elapsed uninterrupted.</p>
</dd></dl>
</div>
<div class="section" id="movies-inside-displayables">
<h2>Movies Inside Displayables<a class="headerlink" href="#movies-inside-displayables" title="Permalink to this headline">¶</a></h2>
<p>A movie can also be displayed inside a displayable, allowing it to be combined with
other things on the screen. To do this, one must first show a Movie displayable, and
then play the movie on an audio channel. (We recommend using the movie channel
for this purpose.)</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">init</span><span class="p">:</span>
<span class="k">image</span> <span class="n">movie</span> <span class="o">=</span> <span class="n">Movie</span><span class="p">(</span><span class="na">size</span><span class="o">=</span><span class="p">(</span><span class="mi">400</span><span class="p">,</span> <span class="mi">300</span><span class="p">),</span> <span class="na">xalign</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span> <span class="na">yalign</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
<span class="k">label</span> <span class="n">movie_sign</span><span class="p">:</span>
<span class="k">scene</span> <span class="n">black</span>
<span class="k">show</span> <span class="n">movie</span>
<span class="k">play</span> <span class="n">movie</span> <span class="s">"incubus.mkv"</span>
<span class="s">"Wow, this movie is really terrible."</span>
<span class="s">"I mean, it stars William Shatner..."</span>
<span class="s">"... speaking Esperanto."</span>
<span class="s">"MAKE IT STOP!"</span>
<span class="k">stop</span> <span class="n">movie</span>
<span class="k">hide</span> <span class="n">movie</span>
<span class="s">"Thats... better."</span>
</pre></div>
</div>
<dl class="function">
<dt id="Movie">
<tt class="descname">Movie</tt><big>(</big><em>fps=24</em>, <em>size=None</em>, <em>**properties</em><big>)</big><a class="headerlink" href="#Movie" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a displayable that shows the current movie.</p>
<dl class="docutils">
<dt><cite>fps</cite></dt>
<dd>The framerate that the movie should be shown at. (This is currently
ignored, but the parameter is kept for backwards compatibility.
The framerate is auto-detected.)</dd>
<dt><cite>size</cite></dt>
<dd>This should always be specified. A tuple giving the width and height
of the movie.</dd>
</dl>
<p>The contents of this displayable when a movie is not playing are undefined.
(And may change when a rollback occurs.)</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="voice.html" title="Voice"
>next</a> |</li>
<li class="right" >
<a href="audio.html" title="Audio"
>previous</a> |</li>
<li> <img src="_static/logo.png" width=19 height=21 align=center>
<li> <a href="http://www.renpy.org/">Ren'Py Home</a> |
<li><a href="index.html">Ren'Py Documentation</a></li>
</ul>
</div>
</body>
</html>
|