2044 lines
121 KiB
HTML
2044 lines
121 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<title>Animation and Transformation Language — Ren'Py Documentation</title>
|
||
|
|
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="_static/bootstrap-3.3.6/css/bootstrap-theme.min.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
|
||
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
|
||
|
|
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
|
||
|
|
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
|
||
|
|
<link rel="index" title="Index" href="genindex.html" />
|
||
|
|
<link rel="search" title="Search" href="search.html" />
|
||
|
|
<link rel="next" title="Matrixcolor" href="matrixcolor.html" />
|
||
|
|
<link rel="prev" title="Transitions" href="transitions.html" />
|
||
|
|
<meta charset='utf-8'>
|
||
|
|
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
|
||
|
|
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
|
||
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
|
|
|
||
|
|
</head><body>
|
||
|
|
|
||
|
|
<div id="navbar" class="navbar navbar-default navbar-fixed-top">
|
||
|
|
<div class="container">
|
||
|
|
<div class="navbar-header">
|
||
|
|
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
|
||
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
|
||
|
|
<span class="icon-bar"></span>
|
||
|
|
<span class="icon-bar"></span>
|
||
|
|
<span class="icon-bar"></span>
|
||
|
|
</button>
|
||
|
|
<a class="navbar-brand" href="index.html">
|
||
|
|
Ren'Py Documentation</a>
|
||
|
|
<span class="navbar-text navbar-version pull-left"><b>7.5.3</b></span>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="collapse navbar-collapse nav-collapse">
|
||
|
|
<ul class="nav navbar-nav">
|
||
|
|
|
||
|
|
<li><a href="https://www.renpy.org">Home Page</a></li>
|
||
|
|
<li><a href="https://www.renpy.org/doc/html/">Online Documentation</a></li>
|
||
|
|
|
||
|
|
|
||
|
|
<li class="dropdown globaltoc-container">
|
||
|
|
<a role="button"
|
||
|
|
id="dLabelGlobalToc"
|
||
|
|
data-toggle="dropdown"
|
||
|
|
data-target="#"
|
||
|
|
href="index.html">Site <b class="caret"></b></a>
|
||
|
|
<ul class="dropdown-menu globaltoc"
|
||
|
|
role="menu"
|
||
|
|
aria-labelledby="dLabelGlobalToc"><ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="gui.html">GUI Customization Guide</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="language_basics.html">Language Basics</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="label.html">Labels & Control Flow</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="dialogue.html">Dialogue and Narration</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="displaying_images.html">Displaying Images</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="menus.html">In-Game Menus</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="python.html">Python Statements</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="conditional.html">Conditional Statements</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="audio.html">Audio</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="movie.html">Movie</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="voice.html">Voice</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="current">
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="text.html">Text</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="displayables.html">Displayables</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="transforms.html">Transforms</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="transitions.html">Transitions</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Animation and Transformation Language</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="matrixcolor.html">Matrixcolor</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="layeredimage.html">Layered Images</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="3dstage.html">3D Stage</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="live2d.html">Live2D Cubism</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="style.html">Styles</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="style_properties.html">Style Properties</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="screens.html">Screens and Screen Language</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="screen_actions.html">Screen Actions, Values, and Functions</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="screen_special.html">Special Screen Names</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="screen_optimization.html">Screen Language Optimization</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="config.html">Configuration Variables</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preference Variables</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="store_variables.html">Store Variables</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="mouse.html">Custom Mouse Cursors</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="launcher.html">Launcher</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="developer_tools.html">Developer Tools</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="director.html">Interactive Director</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="nvl_mode.html">NVL-Mode Tutorial</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="input.html">Text Input</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="side_image.html">Side Images</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="rooms.html">Image Gallery, Music Room, and Replay Actions</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="drag_drop.html">Drag and Drop</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="sprites.html">Sprites</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="keymap.html">Customizing the Keymap</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="achievement.html">Achievements</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="history.html">Dialogue History</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="multiple.html">Multiple Character Dialogue</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="splashscreen_presplash.html">Splashscreen and Presplash</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="statement_equivalents.html">Statement Equivalents</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="save_load_rollback.html">Saving, Loading, and Rollback</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="persistent.html">Persistent Data</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="trans_trans_python.html">Transforms and Transitions in Python</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="gui_advanced.html">Advanced GUI</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="screen_python.html">Screens and Python</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="modes.html">Modes</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdd.html">Creator-Defined Displayables</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cds.html">Creator-Defined Statements</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="custom_text_tags.html">Custom Text Tags</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="character_callbacks.html">Character Callbacks</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="file_python.html">File Access</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="color_class.html">Color Class</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="matrix.html">Matrix</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="model.html">Model-Based Rendering</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="other.html">Other Functions and Variables</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="build.html">Building Distributions</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="updater.html">Web Updater</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="android.html">Android</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="chromeos.html">Chrome OS/Chromebook</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="ios.html">iOS</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="iap.html">In-App Purchasing</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="gesture.html">Gestures</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="raspi.html">Raspberry Pi</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="problems.html">Dealing with Problems</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="environment_variables.html">Environment Variables</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="self_voicing.html">Self-Voicing</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="editor.html">Text Editor Integration</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="skins.html">Skins</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="translating_renpy.html">Translating Ren'Py</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog (Ren'Py 7.x-)</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="changelog6.html">Changelog (Ren'Py 6.11 - 6.99)</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="incompatible.html">Incompatible Changes</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="distributor.html">Distributor Notes</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="sponsors.html">Ren'Py Development Sponsors</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="thequestion.html">Script of The Question</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="thequestion_nvl.html">NVL-mode script for The Question</a></li>
|
||
|
|
</ul>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<form class="navbar-form navbar-right" action="search.html" method="get">
|
||
|
|
<div class="form-group">
|
||
|
|
<input type="text" name="q" class="form-control" placeholder="Search" />
|
||
|
|
</div>
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="container">
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-md-3">
|
||
|
|
<div id="sidebar" class="bs-sidenav" role="complementary"><ul>
|
||
|
|
<li><a class="reference internal" href="#">Animation and Transformation Language</a><ul>
|
||
|
|
<li><a class="reference internal" href="#ren-py-script-statements">Ren'Py Script Statements</a><ul>
|
||
|
|
<li><a class="reference internal" href="#transform-statement">Transform Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#image-statement-with-atl-block">Image Statement With ATL Block</a></li>
|
||
|
|
<li><a class="reference internal" href="#scene-and-show-statements-with-atl-block">Scene and Show Statements with ATL Block</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#atl-syntax-and-semantics">ATL Syntax and Semantics</a></li>
|
||
|
|
<li><a class="reference internal" href="#atl-statements">ATL Statements</a><ul>
|
||
|
|
<li><a class="reference internal" href="#interpolation-statement">Interpolation Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#time-statement">Time Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#expression-statement">Expression Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#pass-statement">Pass Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#repeat-statement">Repeat Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#block-statement">Block Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#choice-statement">Choice Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#parallel-statement">Parallel Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#event-statement">Event Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#on-statement">On Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#contains-statement">Contains Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#function-statement">Function Statement</a></li>
|
||
|
|
<li><a class="reference internal" href="#animation-statement">Animation Statement</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a class="reference internal" href="#warpers">Warpers</a></li>
|
||
|
|
<li><a class="reference internal" href="#list-of-transform-properties">List of Transform Properties</a></li>
|
||
|
|
<li><a class="reference internal" href="#deprecated-transform-properties">Deprecated Transform Properties</a></li>
|
||
|
|
<li><a class="reference internal" href="#circular-motion">Circular Motion</a></li>
|
||
|
|
<li><a class="reference internal" href="#external-events">External Events</a></li>
|
||
|
|
<li><a class="reference internal" href="#replacing-transforms">Replacing Transforms</a></li>
|
||
|
|
<li><a class="reference internal" href="#atl-transitions">ATL Transitions</a></li>
|
||
|
|
<li><a class="reference internal" href="#special-atl-keyword-parameters">Special ATL Keyword Parameters</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-md-9 content">
|
||
|
|
|
||
|
|
<div class="section" id="animation-and-transformation-language">
|
||
|
|
<span id="atl"></span><h1>Animation and Transformation Language<a class="headerlink" href="#animation-and-transformation-language" title="Permalink to this headline"> link</a></h1>
|
||
|
|
<p>The Animation and Transformation Language (ATL) provides a high-level way of
|
||
|
|
choosing a displayable to show, positioning it on the screen, and applying
|
||
|
|
transformations such as rotation, zoom, and alpha-modification. These can be
|
||
|
|
changed over time, and in response to events.</p>
|
||
|
|
<p>The Python equivalent of an ATL transform is the <a class="reference internal" href="trans_trans_python.html#Transform" title="Transform"><code class="xref py py-func docutils literal notranslate"><span class="pre">Transform()</span></code></a>
|
||
|
|
displayable. There is no way to create an ATL transform programmatically.</p>
|
||
|
|
<div class="section" id="ren-py-script-statements">
|
||
|
|
<h2>Ren'Py Script Statements<a class="headerlink" href="#ren-py-script-statements" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>ATL can be included as part of three Ren'Py script statements.</p>
|
||
|
|
<div class="section" id="transform-statement">
|
||
|
|
<span id="id1"></span><h3>Transform Statement<a class="headerlink" href="#transform-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">transform</span></code> statement creates a transform that can be supplied as part of an
|
||
|
|
at clause. The syntax of the transform statement is:</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-transform">atl_transform</strong> ::= "transform" <code class="xref docutils literal notranslate"><span class="pre">name</span></code> "(" <code class="xref docutils literal notranslate"><span class="pre">parameters</span></code> ")" ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>The transform statement must be run at init time. If it is found outside an
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">init</span></code> block, then it is automatically placed inside an <code class="docutils literal notranslate"><span class="pre">init</span></code> block with a
|
||
|
|
priority of 0. The transform may have a list of parameters, which must be
|
||
|
|
supplied when it is called. Default values for the right-most parameters can
|
||
|
|
be given by adding "=" and the value (e.g. "transform a (b, c=0):").</p>
|
||
|
|
<p><cite>Name</cite> must be a Python identifier. The transform created by the ATL block is
|
||
|
|
bound to this name.:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">left_to_right</span><span class="p">:</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">2.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="image-statement-with-atl-block">
|
||
|
|
<span id="atl-image-statement"></span><h3>Image Statement With ATL Block<a class="headerlink" href="#image-statement-with-atl-block" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The second way to use ATL is as part of an <code class="docutils literal notranslate"><span class="pre">image</span></code> statement with ATL block.
|
||
|
|
This binds an image name to the given transform. As there's no way to supply
|
||
|
|
parameters to this transform, it's only useful if the transform defines an
|
||
|
|
animation. The syntax for an image statement with ATL block is:</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-image">atl_image</strong> ::= "image" <code class="xref docutils literal notranslate"><span class="pre">image_name</span></code> ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">image</span> <span class="n">eileen</span> <span class="n">animated</span><span class="p">:</span>
|
||
|
|
<span class="s2">"eileen_happy.png"</span>
|
||
|
|
<span class="k">pause</span> <span class="mf">1.0</span>
|
||
|
|
<span class="s2">"eileen_vhappy.png"</span>
|
||
|
|
<span class="k">pause</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="scene-and-show-statements-with-atl-block">
|
||
|
|
<h3>Scene and Show Statements with ATL Block<a class="headerlink" href="#scene-and-show-statements-with-atl-block" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The final way to use ATL is as part of a <code class="docutils literal notranslate"><span class="pre">scene</span></code> or <code class="docutils literal notranslate"><span class="pre">show</span></code> statement. This wraps
|
||
|
|
the image being shown inside an ATL transformation.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-scene">atl_scene</strong> ::= <code class="xref docutils literal notranslate"><span class="pre">stmt_scene</span></code> ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
<strong id="grammar-token-atl-show">atl_show </strong> ::= <code class="xref docutils literal notranslate"><span class="pre">stmt_show</span></code> ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">scene</span> <span class="n">bg</span> <span class="n">washington</span><span class="p">:</span>
|
||
|
|
<span class="na">zoom</span> <span class="mf">2.0</span>
|
||
|
|
|
||
|
|
<span class="k">show</span> <span class="n">eileen</span> <span class="n">happy</span><span class="p">:</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="atl-syntax-and-semantics">
|
||
|
|
<h2>ATL Syntax and Semantics<a class="headerlink" href="#atl-syntax-and-semantics" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>An ATL block consists of one or more logical lines, all at the same
|
||
|
|
indentation, and indented relative to the statement containing the block.
|
||
|
|
Each logical line in an ATL block must contain one or more ATL statements.</p>
|
||
|
|
<p>There are two kinds of ATL statements: simple and complex. Simple statements
|
||
|
|
do not take an ATL block. A single logical line may contain one or more ATL
|
||
|
|
statements, separated by commas. A complex statement contains a block, must
|
||
|
|
be on its own line. The first line of a complex statement always ends with a
|
||
|
|
colon <code class="docutils literal notranslate"><span class="pre">:</span></code>.</p>
|
||
|
|
<p>By default, statements in a block are executed in the order in which they
|
||
|
|
appear, starting with the first statement in the block. Execution terminates
|
||
|
|
when the end of the block is reached. Time statements change this, as
|
||
|
|
described in the appropriate section below.</p>
|
||
|
|
<p>Execution of a block terminates when all statements in the block have
|
||
|
|
terminated.</p>
|
||
|
|
<p>If an ATL statement requires evaluation of an expression, such evaluation
|
||
|
|
occurs when the transform is first added to the scene list. (Such as when
|
||
|
|
using a <code class="docutils literal notranslate"><span class="pre">show</span></code> statement or <code class="docutils literal notranslate"><span class="pre">ui</span></code> function.)</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="atl-statements">
|
||
|
|
<h2>ATL Statements<a class="headerlink" href="#atl-statements" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>The following are the ATL statements.</p>
|
||
|
|
<div class="section" id="interpolation-statement">
|
||
|
|
<h3>Interpolation Statement<a class="headerlink" href="#interpolation-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The interpolation statement is the main way that ATL controls transformations.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-properties">atl_properties</strong> ::= ( <code class="xref docutils literal notranslate"><span class="pre">property</span></code> <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> ( "knot" <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> )*
|
||
|
|
| "clockwise"
|
||
|
|
| "counterclockwise"
|
||
|
|
| "circles" simple_expression
|
||
|
|
| simple_expression )*
|
||
|
|
</pre>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-interp">atl_interp</strong> ::= ( <code class="xref docutils literal notranslate"><span class="pre">warper</span></code> <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> | "warp" <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> )? <a class="reference internal" href="#grammar-token-atl-properties"><code class="xref docutils literal notranslate"><span class="pre">atl_properties</span></code></a>
|
||
|
|
| ( <code class="xref docutils literal notranslate"><span class="pre">warper</span></code> <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> | "warp" <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> )? ":"
|
||
|
|
<a class="reference internal" href="#grammar-token-atl-properties"><code class="xref docutils literal notranslate"><span class="pre">atl_properties</span></code></a>
|
||
|
|
</pre>
|
||
|
|
<p>The first part of the interpolation statement is used to select a function
|
||
|
|
that time-warps the interpolation. (That is, a function from linear time to
|
||
|
|
non-linear time.) This can either be done by giving the name of a warper
|
||
|
|
registered with ATL, or by giving the
|
||
|
|
keyword "warp" followed by an
|
||
|
|
expression giving a function. Either case is followed by a number, giving the
|
||
|
|
number of seconds the interpolation should take.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">builtin_warper</span><span class="p">:</span>
|
||
|
|
<span class="na">xpos</span> <span class="mi">0</span>
|
||
|
|
<span class="n">ease</span> <span class="mi">5</span> <span class="na">xpos</span> <span class="mi">520</span>
|
||
|
|
|
||
|
|
<span class="k">init</span> <span class="k">python</span><span class="p">:</span>
|
||
|
|
<span class="k">def</span> <span class="nf">my_warper</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
|
||
|
|
<span class="k">return</span> <span class="n">t</span><span class="o">**</span><span class="mf">4.4</span>
|
||
|
|
|
||
|
|
<span class="k">define</span> <span class="n">my_warpers</span> <span class="o">=</span> <span class="p">[</span><span class="n">my_warper</span><span class="p">]</span>
|
||
|
|
|
||
|
|
<span class="k">transform</span> <span class="n">accessed_as_function</span><span class="p">:</span>
|
||
|
|
<span class="na">xpos</span> <span class="mi">0</span>
|
||
|
|
<span class="n">warp</span> <span class="n">my_warpers</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="mi">5</span> <span class="na">xpos</span> <span class="mi">520</span>
|
||
|
|
<span class="n">warp</span> <span class="n">my_warper</span> <span class="mi">3</span> <span class="na">xpos</span> <span class="mi">100</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>See <a class="reference internal" href="#warpers"><span class="std std-ref">Warpers</span></a> for more information about warpers.</p>
|
||
|
|
<p>If no warp function is given, the interpolation is instantaneous. Otherwise,
|
||
|
|
it persists for the amount of time given, and at least one frame.</p>
|
||
|
|
<p>The warper and duration are used to compute a completion fraction. This is
|
||
|
|
done by dividing the time taken by the interpolation by the duration of the
|
||
|
|
interpolation. This is clamped to the duration, and then passed to the
|
||
|
|
warper. The result returned by the warper is the completion fraction.</p>
|
||
|
|
<p>The interpolation statement can then contain a number of other clauses. When a
|
||
|
|
property and value are present, then the value is the value the property will
|
||
|
|
obtain at the end of the statement. The value can be obtained in several ways:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>If the value is followed by one or more knots, then spline motion is used.
|
||
|
|
The starting point is the value of the property at the start of the
|
||
|
|
interpolation, the end point is the property value, and the knots are used
|
||
|
|
to control the spline. A quadratic curve is used for a single knot, Bezier
|
||
|
|
is used when there are two and Catmull-Rom is used for three or more knots.
|
||
|
|
In the former two cases, the knot or knots are simply control nodes. For
|
||
|
|
Catmull-Rom, the first and last knot are control nodes (often outside the
|
||
|
|
displayed path) and the other knots are points the path passes through.</li>
|
||
|
|
<li>If the interpolation statement contains a "clockwise" or
|
||
|
|
"counterclockwise" clause, circular motion is used, as described below.</li>
|
||
|
|
<li>Otherwise, the value is linearly interpolated between the start and end
|
||
|
|
locations, using the completion fraction.</li>
|
||
|
|
</ul>
|
||
|
|
<p>If a simple expression is present, it should evaluate to a transform with only
|
||
|
|
a single interpolation statement, without a warper, splines, or circular
|
||
|
|
motion. The properties from the transform are processed as if they were
|
||
|
|
included in this statement.</p>
|
||
|
|
<p>A warper may be followed by a colon (:). In this case, it may be followed
|
||
|
|
by one or more lines containing the clauses available above. This lets
|
||
|
|
an ATL interpolation apply to multiple lines of properties.</p>
|
||
|
|
<p>Some sample interpolations are:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">show</span> <span class="n">logo</span> <span class="n">base</span><span class="p">:</span>
|
||
|
|
<span class="c1"># Show the logo at the upper right side of the screen.</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">1.0</span> <span class="na">yalign</span> <span class="mf">0.0</span>
|
||
|
|
|
||
|
|
<span class="c1"># Take 1.0 seconds to move things back to the left.</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
|
||
|
|
<span class="c1"># Take 1.0 seconds to move things to the location specified in the</span>
|
||
|
|
<span class="c1"># truecenter transform. Use the ease warper to do this.</span>
|
||
|
|
<span class="n">ease</span> <span class="mf">1.0</span> <span class="n">truecenter</span>
|
||
|
|
|
||
|
|
<span class="c1"># Just pause for a second.</span>
|
||
|
|
<span class="k">pause</span> <span class="mf">1.0</span>
|
||
|
|
|
||
|
|
<span class="c1"># Set the location to circle around.</span>
|
||
|
|
<span class="na">alignaround</span> <span class="p">(</span><span class="o">.</span><span class="mi">5</span><span class="p">,</span> <span class="o">.</span><span class="mi">5</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="c1"># Use circular motion to bring us to spiral out to the top of</span>
|
||
|
|
<span class="c1"># the screen. Take 2 seconds to do so.</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">2.0</span> <span class="na">yalign</span> <span class="mf">0.0</span> <span class="k">clockwise</span> <span class="k">circles</span> <span class="mi">3</span>
|
||
|
|
|
||
|
|
<span class="c1"># Use a spline motion to move us around the screen.</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">2.0</span> <span class="na">align</span> <span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">)</span> <span class="k">knot</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="o">.</span><span class="mi">33</span><span class="p">)</span> <span class="k">knot</span> <span class="p">(</span><span class="mf">1.0</span><span class="p">,</span> <span class="o">.</span><span class="mi">66</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="c1"># Changes xalign and yalign at thje same time.</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">2.0</span> <span class="na">xalign</span> <span class="mf">1.0</span> <span class="na">yalign</span> <span class="mf">1.0</span>
|
||
|
|
|
||
|
|
<span class="c1"># The same thing, using a block.</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">2.0</span><span class="p">:</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="na">yalign</span> <span class="mf">1.0</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>An important special case is that the pause warper, followed by a time and
|
||
|
|
nothing else, causes ATL execution to pause for that amount of time.</p>
|
||
|
|
<p>Some properties can have values of multiple types. For example, the <a class="reference internal" href="style_properties.html#style-property-xpos"><code class="xref std std-propref docutils literal notranslate"><span class="pre">xpos</span></code></a>
|
||
|
|
property can be an int, float, or absolute. The behavior is undefined when an
|
||
|
|
interpolation has old and new property values of different types.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="time-statement">
|
||
|
|
<h3>Time Statement<a class="headerlink" href="#time-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">time</span></code> statement is a simple control statement. It contains a single
|
||
|
|
<cite>simple_expression</cite>, which is evaluated to give a time, expressed as seconds
|
||
|
|
from the start of execution of the containing block.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-time">atl_time</strong> ::= "time" <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>When the time given in the statement is reached, the following statement
|
||
|
|
begins to execute. This transfer of control occurs even if a previous
|
||
|
|
statement is still executing, and causes any prior statement to immediately
|
||
|
|
terminate.</p>
|
||
|
|
<p>Time statements are implicitly preceded by a pause statement with an infinite
|
||
|
|
time. This means that if control would otherwise reach the time statement, it
|
||
|
|
waits until the time statement would take control.</p>
|
||
|
|
<p>When there are multiple time statements in a block, they must strictly
|
||
|
|
increase in order.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">image</span> <span class="n">backgrounds</span><span class="p">:</span>
|
||
|
|
<span class="s2">"bg band"</span>
|
||
|
|
<span class="k">time</span> <span class="mf">2.0</span>
|
||
|
|
<span class="s2">"bg whitehouse"</span>
|
||
|
|
<span class="k">time</span> <span class="mf">4.0</span>
|
||
|
|
<span class="s2">"bg washington"</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="expression-statement">
|
||
|
|
<h3>Expression Statement<a class="headerlink" href="#expression-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>An expression statement is a simple statement that starts with a simple
|
||
|
|
expression. It then contains an optional with clause, with a second simple
|
||
|
|
expression.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-expression">atl_expression</strong> ::= <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code> ("with" <code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code>)?
|
||
|
|
</pre>
|
||
|
|
<p>There are three things the first simple expression may evaluate to:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>If it's an ATL transform, and that ATL transform has <strong>not</strong> been supplied
|
||
|
|
a child (through being called as a transform or transition, or
|
||
|
|
with a <cite>child</cite> or <cite>old_widget</cite> argument), the ATL transform is
|
||
|
|
included at the location of the expression. The <code class="docutils literal notranslate"><span class="pre">with</span></code> clause is ignored.</li>
|
||
|
|
<li>If it's an integer or floating point number, it's taken as a number of
|
||
|
|
seconds to pause execution for. The <code class="docutils literal notranslate"><span class="pre">with</span></code> clause is ignored.</li>
|
||
|
|
<li>Otherwise, the expression is interpreted to be a displayable. This
|
||
|
|
displayable replaces the child of the transform when this clause executes,
|
||
|
|
making it useful for animation. If a <code class="docutils literal notranslate"><span class="pre">with</span></code> clause is present, the second
|
||
|
|
expression is evaluated as a transition, and the transition is applied to
|
||
|
|
the old and new displayables.</li>
|
||
|
|
</ul>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">move_right</span><span class="p">:</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
|
||
|
|
<span class="k">image</span> <span class="n">atl</span> <span class="n">example</span><span class="p">:</span>
|
||
|
|
<span class="c1"># Display logo_base.png</span>
|
||
|
|
<span class="s2">"logo_base.png"</span>
|
||
|
|
|
||
|
|
<span class="c1"># Pause for 1.0 seconds.</span>
|
||
|
|
<span class="mf">1.0</span>
|
||
|
|
|
||
|
|
<span class="c1"># Show logo_bw.png, with a dissolve.</span>
|
||
|
|
<span class="s2">"logo_bw.png"</span> <span class="k">with</span> <span class="n">Dissolve</span><span class="p">(</span><span class="mf">0.5</span><span class="p">,</span> <span class="na">alpha</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="c1"># Run the move_right transform.</span>
|
||
|
|
<span class="n">move_right</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="pass-statement">
|
||
|
|
<h3>Pass Statement<a class="headerlink" href="#pass-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-pass">atl_pass</strong> ::= "pass"
|
||
|
|
</pre>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">pass</span></code> statement is a simple statement that causes nothing to happen. This
|
||
|
|
can be used when there's a desire to separate statements, like when there are
|
||
|
|
two sets of choice statements that would otherwise be back-to-back.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="repeat-statement">
|
||
|
|
<h3>Repeat Statement<a class="headerlink" href="#repeat-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">repeat</span></code> statement is a simple statement that causes the block containing it
|
||
|
|
to resume execution from the beginning. If the expression is present, then it
|
||
|
|
is evaluated to give an integer number of times the block will execute. (So a
|
||
|
|
block ending with <code class="docutils literal notranslate"><span class="pre">repeat</span> <span class="pre">2</span></code> will execute at most twice.)</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-repeat">atl_repeat</strong> ::= "repeat" (<code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code>)?
|
||
|
|
</pre>
|
||
|
|
<p>The repeat statement must be the last statement in a block.:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">show</span> <span class="n">logo</span> <span class="n">base</span><span class="p">:</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="block-statement">
|
||
|
|
<h3>Block Statement<a class="headerlink" href="#block-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">block</span></code> statement is a complex statement that contains a block of ATL statements.
|
||
|
|
This can be used to group statements that will repeat.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-block-stmt">atl_block_stmt</strong> ::= "block" ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">show</span> <span class="n">logo</span> <span class="n">base</span><span class="p">:</span>
|
||
|
|
<span class="na">alpha</span> <span class="mf">0.0</span> <span class="na">xalign</span> <span class="mf">0.0</span> <span class="na">yalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">alpha</span> <span class="mf">1.0</span>
|
||
|
|
|
||
|
|
<span class="k">block</span><span class="p">:</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="choice-statement">
|
||
|
|
<h3>Choice Statement<a class="headerlink" href="#choice-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">choice</span></code> statement is a complex statement that defines one of a set of
|
||
|
|
potential choices. Ren'Py will pick one of the choices in the set, and
|
||
|
|
execute the ATL block associated with it, and then continue execution after
|
||
|
|
the last choice in the choice set.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-choice">atl_choice</strong> ::= "choice" (<code class="xref docutils literal notranslate"><span class="pre">simple_expression</span></code>)? ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>Choice statements are greedily grouped into a choice set when more than one
|
||
|
|
choice statement appears consecutively in a block. If the <cite>simple_expression</cite>
|
||
|
|
is supplied, it is a floating-point weight given to that block, otherwise 1.0
|
||
|
|
is assumed.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">image</span> <span class="n">eileen</span> <span class="n">random</span><span class="p">:</span>
|
||
|
|
<span class="k">choice</span><span class="p">:</span>
|
||
|
|
<span class="s2">"eileen happy"</span>
|
||
|
|
<span class="k">choice</span><span class="p">:</span>
|
||
|
|
<span class="s2">"eileen vhappy"</span>
|
||
|
|
<span class="k">choice</span><span class="p">:</span>
|
||
|
|
<span class="s2">"eileen concerned"</span>
|
||
|
|
|
||
|
|
<span class="k">pause</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="parallel-statement">
|
||
|
|
<h3>Parallel Statement<a class="headerlink" href="#parallel-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">parallel</span></code> statement is used to define a set of ATL blocks to execute in
|
||
|
|
parallel.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-parallel">atl_parallel</strong> ::= "parallel" ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>Parallel statements are greedily grouped into a parallel set when more than
|
||
|
|
one parallel statement appears consecutively in a block. The blocks of all
|
||
|
|
parallel statements are then executed simultaneously. The parallel statement
|
||
|
|
terminates when the last block terminates.</p>
|
||
|
|
<p>The blocks within a set should be independent of each other, and manipulate
|
||
|
|
different properties. When two blocks change the same property, the result is
|
||
|
|
undefined.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">show</span> <span class="n">logo</span> <span class="n">base</span><span class="p">:</span>
|
||
|
|
<span class="k">parallel</span><span class="p">:</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.3</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.3</span> <span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
<span class="k">parallel</span><span class="p">:</span>
|
||
|
|
<span class="na">yalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.6</span> <span class="na">yalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.6</span> <span class="na">yalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="event-statement">
|
||
|
|
<h3>Event Statement<a class="headerlink" href="#event-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">event</span></code> statement is a simple statement that causes an event with the given
|
||
|
|
name to be produced.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-event">atl_event</strong> ::= "event" <code class="xref docutils literal notranslate"><span class="pre">name</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>When an event is produced inside a block, the block is checked to see if an
|
||
|
|
event handler for the given name exists. If it does, control is transferred
|
||
|
|
to the event handler. Otherwise, the event propagates to any containing event
|
||
|
|
handler.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="on-statement">
|
||
|
|
<h3>On Statement<a class="headerlink" href="#on-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">on</span></code> statement is a complex statement that defines an event handler. On
|
||
|
|
statements are greedily grouped into a single statement. On statement can
|
||
|
|
handle a single event name, or a comma-separated list of event names.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-on">atl_on</strong> ::= "on" <code class="xref docutils literal notranslate"><span class="pre">name</span></code> [ "," <code class="xref docutils literal notranslate"><span class="pre">name</span></code> ] * ":"
|
||
|
|
<code class="xref docutils literal notranslate"><span class="pre">atl_block</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>The on statement is used to handle events. When an event is handled, handling
|
||
|
|
of any other event ends and handing of the new event immediately starts. When
|
||
|
|
an event handler ends without another event occurring, the <code class="docutils literal notranslate"><span class="pre">default</span></code> event
|
||
|
|
is produced (unless were already handing the <code class="docutils literal notranslate"><span class="pre">default</span></code> event).</p>
|
||
|
|
<p>Execution of the on statement will never naturally end. (But it can be ended
|
||
|
|
by the time statement, or an enclosing event handler.)</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">show</span> <span class="n">logo</span> <span class="n">base</span><span class="p">:</span>
|
||
|
|
<span class="k">on</span> <span class="k">show</span><span class="p">:</span>
|
||
|
|
<span class="na">alpha</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="o">.</span><span class="mi">5</span> <span class="na">alpha</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">on</span> <span class="k">hide</span><span class="p">:</span>
|
||
|
|
<span class="n">linear</span> <span class="o">.</span><span class="mi">5</span> <span class="na">alpha</span> <span class="mf">0.0</span>
|
||
|
|
|
||
|
|
<span class="k">transform</span> <span class="n">pulse_button</span><span class="p">:</span>
|
||
|
|
<span class="k">on</span> <span class="na">hover</span><span class="p">,</span> <span class="na">idle</span><span class="p">:</span>
|
||
|
|
<span class="n">linear</span> <span class="o">.</span><span class="mi">25</span> <span class="na">zoom</span> <span class="mf">1.25</span>
|
||
|
|
<span class="n">linear</span> <span class="o">.</span><span class="mi">25</span> <span class="na">zoom</span> <span class="mf">1.0</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="contains-statement">
|
||
|
|
<h3>Contains Statement<a class="headerlink" href="#contains-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">contains</span></code> statement sets the displayable contained by this ATL transform
|
||
|
|
(the child of the transform). There are two variants of the contains
|
||
|
|
statement.</p>
|
||
|
|
<p>The contains expression variant takes an expression, and sets that expression
|
||
|
|
as the child of the transform. This is useful when an ATL transform wishes to
|
||
|
|
contain, rather than include, a second ATL transform.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-contains">atl_contains</strong> ::= "contains" <code class="xref docutils literal notranslate"><span class="pre">expression</span></code>
|
||
|
|
</pre>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">an_animation</span><span class="p">:</span>
|
||
|
|
<span class="s2">"1.png"</span>
|
||
|
|
<span class="k">pause</span> <span class="mi">2</span>
|
||
|
|
<span class="s2">"2.png"</span>
|
||
|
|
<span class="k">pause</span> <span class="mi">2</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
|
||
|
|
<span class="k">image</span> <span class="n">move_an_animation</span><span class="p">:</span>
|
||
|
|
<span class="k">contains</span> <span class="n">an_animation</span>
|
||
|
|
|
||
|
|
<span class="c1"># If we didn't use contains, we'd still be looping and</span>
|
||
|
|
<span class="c1"># would never reach here.</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">yalign</span> <span class="mf">1.0</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>The contains block allows one to define an ATL block that is used for the
|
||
|
|
child of this ATL transform. One or more contains block statements will be
|
||
|
|
greedily grouped together, wrapped inside a <a class="reference internal" href="displayables.html#Fixed" title="Fixed"><code class="xref py py-func docutils literal notranslate"><span class="pre">Fixed()</span></code></a>, and set as the
|
||
|
|
child of this transform.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-counts">atl_counts</strong> ::= "contains" ":"
|
||
|
|
</pre>
|
||
|
|
<p>Each block should define a displayable to use, or else an error will occur.
|
||
|
|
The contains statement executes instantaneously, without waiting for the
|
||
|
|
children to complete. This statement is mostly syntactic sugar, as it allows
|
||
|
|
arguments to be easily passed to the children.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">image</span> <span class="n">test</span> <span class="n">double</span><span class="p">:</span>
|
||
|
|
<span class="k">contains</span><span class="p">:</span>
|
||
|
|
<span class="s2">"logo.png"</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
|
||
|
|
<span class="k">contains</span><span class="p">:</span>
|
||
|
|
<span class="s2">"logo.png"</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">1.0</span> <span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="function-statement">
|
||
|
|
<h3>Function Statement<a class="headerlink" href="#function-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">function</span></code> statement allows ATL to use Python functions to control the ATL
|
||
|
|
properties.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-function">atl_function</strong> ::= "function" <code class="xref docutils literal notranslate"><span class="pre">expression</span></code>
|
||
|
|
</pre>
|
||
|
|
<p>The functions have the same signature as those used with <a class="reference internal" href="trans_trans_python.html#Transform" title="Transform"><code class="xref py py-func docutils literal notranslate"><span class="pre">Transform()</span></code></a>:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>The first argument is a transform object. Transform properties can be set
|
||
|
|
on this object.</li>
|
||
|
|
<li>The second argument is the shown timebase, the number of seconds since the
|
||
|
|
function began executing.</li>
|
||
|
|
<li>The third argument is the the animation timebase, which is the number of
|
||
|
|
seconds something with the same tag has been on the screen.</li>
|
||
|
|
<li>If the function returns a number, it will be called again after that
|
||
|
|
number of seconds has elapsed. (0 seconds means to call the function as
|
||
|
|
soon as possible.) If the function returns None, control will pass to the
|
||
|
|
next ATL statement.</li>
|
||
|
|
</ul>
|
||
|
|
<p>This function should not have side effects other
|
||
|
|
than changing the Transform object in the first argument, and may be
|
||
|
|
called at any time with any value to enable prediction.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">init</span> <span class="k">python</span><span class="p">:</span>
|
||
|
|
<span class="k">def</span> <span class="nf">slide_function</span><span class="p">(</span><span class="n">trans</span><span class="p">,</span> <span class="n">st</span><span class="p">,</span> <span class="k">at</span><span class="p">):</span>
|
||
|
|
<span class="k">if</span> <span class="n">st</span> <span class="o">></span> <span class="mf">1.0</span><span class="p">:</span>
|
||
|
|
<span class="n">trans</span><span class="o">.</span><span class="na">xalign</span> <span class="o">=</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">return</span> <span class="kc">None</span>
|
||
|
|
<span class="k">else</span><span class="p">:</span>
|
||
|
|
<span class="n">trans</span><span class="o">.</span><span class="na">xalign</span> <span class="o">=</span> <span class="n">st</span>
|
||
|
|
<span class="k">return</span> <span class="mi">0</span>
|
||
|
|
|
||
|
|
<span class="k">label</span> <span class="n">start</span><span class="p">:</span>
|
||
|
|
<span class="k">show</span> <span class="n">logo</span> <span class="n">base</span><span class="p">:</span>
|
||
|
|
<span class="k">function</span> <span class="n">slide_function</span>
|
||
|
|
<span class="k">pause</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="animation-statement">
|
||
|
|
<h3>Animation Statement<a class="headerlink" href="#animation-statement" title="Permalink to this headline"> link</a></h3>
|
||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">animation</span></code> statement must be the first statement in an ATL block,
|
||
|
|
and tells Ren'Py this statement uses the animation timebase.</p>
|
||
|
|
<pre>
|
||
|
|
<strong id="grammar-token-atl-animation">atl_animation</strong> ::= "animation"
|
||
|
|
</pre>
|
||
|
|
<p>As compared to the normal showing timebase, the animation timebase starts
|
||
|
|
when an image or screen with the same tag is shown. This is generally used
|
||
|
|
to have one image replaced by a second one at the same apparent time. For
|
||
|
|
example:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">image</span> <span class="n">eileen</span> <span class="n">happy</span> <span class="n">moving</span><span class="p">:</span>
|
||
|
|
<span class="k">animation</span>
|
||
|
|
<span class="s2">"eileen happy"</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">5.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
|
||
|
|
<span class="k">image</span> <span class="n">eileen</span> <span class="n">vhappy</span> <span class="n">moving</span><span class="p">:</span>
|
||
|
|
<span class="k">animation</span>
|
||
|
|
<span class="s2">"eileen vhappy"</span>
|
||
|
|
<span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">5.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
|
||
|
|
<span class="k">label</span> <span class="n">start</span><span class="p">:</span>
|
||
|
|
|
||
|
|
<span class="k">show</span> <span class="n">eileen</span> <span class="n">happy</span> <span class="n">moving</span>
|
||
|
|
<span class="k">pause</span>
|
||
|
|
<span class="k">show</span> <span class="n">eileen</span> <span class="n">vhappy</span> <span class="n">moving</span>
|
||
|
|
<span class="k">pause</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>This example will cause Eileen to change expression when the first pause
|
||
|
|
finishes, but will not cause her postion to change, as both animations
|
||
|
|
share the same animation time, and hence will place her sprite in the same place.
|
||
|
|
Without the animation statement, the position would reset when the player
|
||
|
|
clicks.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="warpers">
|
||
|
|
<span id="id2"></span><h2>Warpers<a class="headerlink" href="#warpers" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>A warper is a function that can change the amount of time an interpolation
|
||
|
|
statement considers to have elapsed. The following warpers are defined by
|
||
|
|
default. They are defined as functions from t to t', where t and t' are
|
||
|
|
floating point numbers, with t ranging from 0.0 to 1.0 over the given
|
||
|
|
amount of time. (If the statement has 0 duration, then t is 1.0 when it runs.)
|
||
|
|
t' should start at 0.0 and end at 1.0, but can be greater or less.</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">pause</span></code></dt>
|
||
|
|
<dd>Pause, then jump to the new value. If t == 1.0, t = 1.0. Otherwise, t'
|
||
|
|
= 0.0.</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">linear</span></code></dt>
|
||
|
|
<dd>Linear interpolation. t' = t</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">ease</span></code></dt>
|
||
|
|
<dd>Start slow, speed up, then slow down. t' = .5 - math.cos(math.pi
|
||
|
|
* t) / 2.0</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">easein</span></code></dt>
|
||
|
|
<dd>Start fast, then slow down. t' = math.cos((1.0 - t) * math.pi / 2.0</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">easeout</span></code></dt>
|
||
|
|
<dd>Start slow, then speed up. t' = 1.0 - math.cos(t * math.pi / 2.0)</dd>
|
||
|
|
</dl>
|
||
|
|
<p>In addition, most of Robert Penner's easing functions are supported. To
|
||
|
|
make the names match those above, the functions have been renamed
|
||
|
|
somewhat. Graphs of these standard functions can be found at
|
||
|
|
<a class="reference external" href="http://www.easings.net/">http://www.easings.net/</a>.</p>
|
||
|
|
<table border="1" class="docutils">
|
||
|
|
<colgroup>
|
||
|
|
<col width="50%" />
|
||
|
|
<col width="50%" />
|
||
|
|
</colgroup>
|
||
|
|
<thead valign="bottom">
|
||
|
|
<tr class="row-odd"><th class="head">Ren'Py Name</th>
|
||
|
|
<th class="head">easings.net Name</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="row-even"><td>ease_back</td>
|
||
|
|
<td>easeInOut_back</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>ease_bounce</td>
|
||
|
|
<td>easeInOut_bounce</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>ease_circ</td>
|
||
|
|
<td>easeInOut_circ</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>ease_cubic</td>
|
||
|
|
<td>easeInOut_cubic</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>ease_elastic</td>
|
||
|
|
<td>easeInOut_elastic</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>ease_expo</td>
|
||
|
|
<td>easeInOut_expo</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>ease_quad</td>
|
||
|
|
<td>easeInOut_quad</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>ease_quart</td>
|
||
|
|
<td>easeInOut_quart</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>ease_quint</td>
|
||
|
|
<td>easeInOut_quint</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easein_back</td>
|
||
|
|
<td>easeOut_back</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easein_bounce</td>
|
||
|
|
<td>easeOut_bounce</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easein_circ</td>
|
||
|
|
<td>easeOut_circ</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easein_cubic</td>
|
||
|
|
<td>easeOut_cubic</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easein_elastic</td>
|
||
|
|
<td>easeOut_elastic</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easein_expo</td>
|
||
|
|
<td>easeOut_expo</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easein_quad</td>
|
||
|
|
<td>easeOut_quad</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easein_quart</td>
|
||
|
|
<td>easeOut_quart</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easein_quint</td>
|
||
|
|
<td>easeOut_quint</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easeout_back</td>
|
||
|
|
<td>easeIn_back</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easeout_bounce</td>
|
||
|
|
<td>easeIn_bounce</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easeout_circ</td>
|
||
|
|
<td>easeIn_circ</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easeout_cubic</td>
|
||
|
|
<td>easeIn_cubic</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easeout_elastic</td>
|
||
|
|
<td>easeIn_elastic</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easeout_expo</td>
|
||
|
|
<td>easeIn_expo</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easeout_quad</td>
|
||
|
|
<td>easeIn_quad</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td>easeout_quart</td>
|
||
|
|
<td>easeIn_quart</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>easeout_quint</td>
|
||
|
|
<td>easeIn_quint</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>These warpers can be accessed in the <code class="docutils literal notranslate"><span class="pre">_warper</span></code> read-only module, which contains
|
||
|
|
the functions listed above.</p>
|
||
|
|
<p>New warpers can be defined using the <code class="docutils literal notranslate"><span class="pre">renpy.atl_warper</span></code> decorator, in a <code class="docutils literal notranslate"><span class="pre">python</span>
|
||
|
|
<span class="pre">early</span></code> block. It should be placed in a file that is parsed before any file
|
||
|
|
that uses the warper. This looks like:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">python</span> <span class="n">early</span> <span class="k">hide</span><span class="p">:</span>
|
||
|
|
|
||
|
|
<span class="nd">@renpy</span><span class="o">.</span><span class="n">atl_warper</span>
|
||
|
|
<span class="k">def</span> <span class="nf">linear</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
|
||
|
|
<span class="k">return</span> <span class="n">t</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="list-of-transform-properties">
|
||
|
|
<span id="transform-properties"></span><h2>List of Transform Properties<a class="headerlink" href="#list-of-transform-properties" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>The following transform properties exist.</p>
|
||
|
|
<p>When the type is given as position, it may be an int, an <code class="docutils literal notranslate"><span class="pre">absolute</span></code>, or a
|
||
|
|
float. If it's a float, it's interpreted as a fraction of the size of the
|
||
|
|
containing area (for <a class="reference internal" href="style_properties.html#style-property-pos"><code class="xref std std-propref docutils literal notranslate"><span class="pre">pos</span></code></a>) or displayable (for <a class="reference internal" href="style_properties.html#style-property-anchor"><code class="xref std std-propref docutils literal notranslate"><span class="pre">anchor</span></code></a>).</p>
|
||
|
|
<p>Note that not all properties are independent. For example, <a class="reference internal" href="style_properties.html#style-property-xalign"><code class="xref std std-propref docutils literal notranslate"><span class="pre">xalign</span></code></a> and <a class="reference internal" href="style_properties.html#style-property-xpos"><code class="xref std std-propref docutils literal notranslate"><span class="pre">xpos</span></code></a>
|
||
|
|
both update some of the same underlying data. In a parallel statement, only
|
||
|
|
one block should adjust horizontal position, and one should adjust vertical
|
||
|
|
positions. (These may be the same block.) The angle and radius properties set
|
||
|
|
both horizontal and vertical positions.</p>
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-pos">
|
||
|
|
<code class="descname">pos</code><a class="headerlink" href="#transform-property-pos" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0, 0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The position, relative to the top-left corner of the containing
|
||
|
|
area.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xpos">
|
||
|
|
<code class="descname">xpos</code><a class="headerlink" href="#transform-property-xpos" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The horizontal position, relative to the left side of the
|
||
|
|
containing area.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-ypos">
|
||
|
|
<code class="descname">ypos</code><a class="headerlink" href="#transform-property-ypos" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The vertical position, relative to the top of the containing area.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-anchor">
|
||
|
|
<code class="descname">anchor</code><a class="headerlink" href="#transform-property-anchor" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0, 0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The anchor position, relative to the top-left corner of the
|
||
|
|
displayable.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xanchor">
|
||
|
|
<code class="descname">xanchor</code><a class="headerlink" href="#transform-property-xanchor" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The horizontal anchor position, relative to the left side of the
|
||
|
|
displayable.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-yanchor">
|
||
|
|
<code class="descname">yanchor</code><a class="headerlink" href="#transform-property-yanchor" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The vertical anchor position, relative to the top of the
|
||
|
|
displayable.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-align">
|
||
|
|
<code class="descname">align</code><a class="headerlink" href="#transform-property-align" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(float, float)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0.0, 0.0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Equivalent to setting pos and anchor to the same value.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xalign">
|
||
|
|
<code class="descname">xalign</code><a class="headerlink" href="#transform-property-xalign" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Equivalent to setting xpos and xanchor to this value.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-yalign">
|
||
|
|
<code class="descname">yalign</code><a class="headerlink" href="#transform-property-yalign" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Equivalent to setting ypos and yanchor to this value.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-offset">
|
||
|
|
<code class="descname">offset</code><a class="headerlink" href="#transform-property-offset" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(int, int)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0, 0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The number of pixels the displayable is offset by in each direction.
|
||
|
|
Positive values offset towards the bottom-right.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xoffset">
|
||
|
|
<code class="descname">xoffset</code><a class="headerlink" href="#transform-property-xoffset" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The number of pixels the displayable is offset by in the horizontal
|
||
|
|
direction. Positive values offset toward the right.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-yoffset">
|
||
|
|
<code class="descname">yoffset</code><a class="headerlink" href="#transform-property-yoffset" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The number of pixels the displayable is offset by in the vertical
|
||
|
|
direction. Positive values offset toward the bottom.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xycenter">
|
||
|
|
<code class="descname">xycenter</code><a class="headerlink" href="#transform-property-xycenter" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0.0, 0.0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Equivalent to setting pos to the value of this property, and
|
||
|
|
anchor to (0.5, 0.5).</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xcenter">
|
||
|
|
<code class="descname">xcenter</code><a class="headerlink" href="#transform-property-xcenter" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Equivalent to setting xpos to the value of this property, and
|
||
|
|
xanchor to 0.5.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-ycenter">
|
||
|
|
<code class="descname">ycenter</code><a class="headerlink" href="#transform-property-ycenter" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Equivalent to setting ypos to the value of this property, and
|
||
|
|
yanchor to 0.5.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-rotate">
|
||
|
|
<code class="descname">rotate</code><a class="headerlink" href="#transform-property-rotate" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float or None</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If None, no rotation occurs. Otherwise, the image will be rotated
|
||
|
|
by this many degrees clockwise. Rotating the displayable causes it
|
||
|
|
to be resized, according to the setting of rotate_pad, below. This
|
||
|
|
can cause positioning to change if xanchor and yanchor are not
|
||
|
|
0.5.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-rotate_pad">
|
||
|
|
<code class="descname">rotate_pad</code><a class="headerlink" href="#transform-property-rotate_pad" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">True</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If True, then a rotated displayable is padded such that the width
|
||
|
|
and height are equal to the hypotenuse of the original width and
|
||
|
|
height. This ensures that the transform will not change size as
|
||
|
|
its contents rotate. If False, the transform will be given the
|
||
|
|
minimal size that contains the transformed displayable. This is
|
||
|
|
more suited to fixed rotations.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-transform_anchor">
|
||
|
|
<code class="descname">transform_anchor</code><a class="headerlink" href="#transform-property-transform_anchor" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">False</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If true, the anchor point is located on the cropped child, and is scaled
|
||
|
|
and rotated as the child is transformed. Effectively, this makes the
|
||
|
|
anchor the point that the child is rotated and scaled around.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-zoom">
|
||
|
|
<code class="descname">zoom</code><a class="headerlink" href="#transform-property-zoom" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">1.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This causes the displayable to be zoomed by the supplied
|
||
|
|
factor.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xzoom">
|
||
|
|
<code class="descname">xzoom</code><a class="headerlink" href="#transform-property-xzoom" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">1.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This causes the displayable to be horizontally zoomed by the
|
||
|
|
supplied factor. A negative value causes the image to be
|
||
|
|
flipped horizontally.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-yzoom">
|
||
|
|
<code class="descname">yzoom</code><a class="headerlink" href="#transform-property-yzoom" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">1.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This causes the displayable to be vertically zoomed by the supplied
|
||
|
|
factor. A negative value causes the image to be flipped vertically.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-nearest">
|
||
|
|
<code class="descname">nearest</code><a class="headerlink" href="#transform-property-nearest" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If True, the displayable and its children are drawn using nearest-neighbor
|
||
|
|
filtering. If False, the displayable and its children are drawn using
|
||
|
|
bilinear filtering. If None, this is inherited from the parent, or
|
||
|
|
<a class="reference internal" href="config.html#var-config.nearest_neighbor"><code class="xref std std-var docutils literal notranslate"><span class="pre">config.nearest_neighbor</span></code></a>, which defaults to False.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-alpha">
|
||
|
|
<code class="descname">alpha</code><a class="headerlink" href="#transform-property-alpha" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">1.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This controls the opacity of the displayable.</p>
|
||
|
|
<p>The alpha transform is applied to each image comprising the child of
|
||
|
|
the transform independently. This can lead to unexpected results when
|
||
|
|
the children overlap, such as as seeing a character through clothing.
|
||
|
|
The <a class="reference internal" href="displayables.html#Flatten" title="Flatten"><code class="xref py py-func docutils literal notranslate"><span class="pre">Flatten()</span></code></a> displayable can help with these problems.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-additive">
|
||
|
|
<code class="descname">additive</code><a class="headerlink" href="#transform-property-additive" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This controls how much additive blending Ren'Py performs. When 1.0,
|
||
|
|
Ren'Py draws using the ADD operator. When 0.0, Ren'Py draws using
|
||
|
|
the OVER operator.</p>
|
||
|
|
<p>Additive blending is performed on each child of the transform independently.</p>
|
||
|
|
<p>Fully additive blending doesn't alter the alpha channel of the destination,
|
||
|
|
and additive images may not be visible if they're not drawn directly onto
|
||
|
|
an opaque surface. (Complex operations, like viewport, <a class="reference internal" href="displayables.html#Flatten" title="Flatten"><code class="xref py py-func docutils literal notranslate"><span class="pre">Flatten()</span></code></a>, <a class="reference internal" href="displayables.html#Frame" title="Frame"><code class="xref py py-func docutils literal notranslate"><span class="pre">Frame()</span></code></a>,
|
||
|
|
and certain transitions may cause problems with additive blending.)</p>
|
||
|
|
<div class="admonition warning">
|
||
|
|
<p class="first admonition-title">Warning</p>
|
||
|
|
<p>Additive blending is only supported by hardware-based renderers, such
|
||
|
|
as the OpenGL and DirectX/ANGLE renderers. The software renderer will
|
||
|
|
draw additive images incorrectly.</p>
|
||
|
|
<p class="last">Once the graphics system has started, <code class="docutils literal notranslate"><span class="pre">renpy.get_renderer_info()["additive"]</span></code>
|
||
|
|
will be true if additive blending is supported.</p>
|
||
|
|
</div>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-around">
|
||
|
|
<code class="descname">around</code><a class="headerlink" href="#transform-property-around" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0.0, 0.0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, specifies the polar coordinate center, relative to
|
||
|
|
the upper-left of the containing area. Setting the center using
|
||
|
|
this allows for circular motion in position mode.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-alignaround">
|
||
|
|
<code class="descname">alignaround</code><a class="headerlink" href="#transform-property-alignaround" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">(float, float)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">(0.0, 0.0)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, specifies the polar coordinate center, relative to
|
||
|
|
the upper-left of the containing area. Setting the center using
|
||
|
|
this allows for circular motion in align mode.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-angle">
|
||
|
|
<code class="descname">angle</code><a class="headerlink" href="#transform-property-angle" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Get the angle component of the polar coordinate position. This is
|
||
|
|
undefined when the polar coordinate center is not set.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-radius">
|
||
|
|
<code class="descname">radius</code><a class="headerlink" href="#transform-property-radius" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">position</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Get the radius component of the polar coordinate position. This is
|
||
|
|
undefined when the polar coordinate center is not set.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-crop">
|
||
|
|
<code class="descname">crop</code><a class="headerlink" href="#transform-property-crop" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or (position, position, position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, causes the displayable to be cropped to the given
|
||
|
|
box. The box is specified as a tuple of (x, y, width, height).</p>
|
||
|
|
<p>If corners and crop are given, crop takes priority over corners.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-corner1">
|
||
|
|
<code class="descname">corner1</code><a class="headerlink" href="#transform-property-corner1" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or (position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, gives the upper-left corner of the crop box. Crop takes
|
||
|
|
priority over corners. When a float, and crop_relative is enabled,
|
||
|
|
this is relative to the size of the child.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-corner2">
|
||
|
|
<code class="descname">corner2</code><a class="headerlink" href="#transform-property-corner2" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or (position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, gives the lower right corner of the crop box. Cropt takes
|
||
|
|
priority over corners. When a float, and crop_relativer is enabled, this
|
||
|
|
is relative to the size of the child.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xysize">
|
||
|
|
<code class="descname">xysize</code><a class="headerlink" href="#transform-property-xysize" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or (position, position)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, causes the displayable to be scaled to the given
|
||
|
|
size. This is equivalent to setting the <a class="reference internal" href="#transform-property-xsize"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xsize</span></code></a> and
|
||
|
|
<a class="reference internal" href="#transform-property-ysize"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">ysize</span></code></a> properties to the first and second components.</p>
|
||
|
|
<p>This is affected by the <a class="reference internal" href="#transform-property-fit"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">fit</span></code></a> property.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xsize">
|
||
|
|
<code class="descname">xsize</code><a class="headerlink" href="#transform-property-xsize" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, causes the displayable to be scaled to the given width.</p>
|
||
|
|
<p>This is affected by the <a class="reference internal" href="#transform-property-fit"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">fit</span></code></a> property.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-ysize">
|
||
|
|
<code class="descname">ysize</code><a class="headerlink" href="#transform-property-ysize" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or position</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, causes the displayable to be scaled to the given height.</p>
|
||
|
|
<p>This is affected by the <a class="reference internal" href="#transform-property-fit"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">fit</span></code></a> property.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-fit">
|
||
|
|
<code class="descname">fit</code><a class="headerlink" href="#transform-property-fit" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or string</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Causes the displayable to be sized according to the table below.
|
||
|
|
In the context of the the table below, the "dimensions" are:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li>If both <a class="reference internal" href="#transform-property-xsize"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xsize</span></code></a> and <a class="reference internal" href="#transform-property-ysize"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">ysize</span></code></a> are not None, both sizes
|
||
|
|
are used as the dimensions.</li>
|
||
|
|
<li>If only one of those properties is not None, it is used as the
|
||
|
|
sole dimension.</li>
|
||
|
|
<li>Otherwise, if fit is not None the area that the Transform is
|
||
|
|
contained in is used as the dimensions.</li>
|
||
|
|
</ul>
|
||
|
|
<p>If fit, xsize, and ysize are all None, this property does not apply.</p>
|
||
|
|
<table border="1" class="colwidths-given docutils">
|
||
|
|
<colgroup>
|
||
|
|
<col width="15%" />
|
||
|
|
<col width="85%" />
|
||
|
|
</colgroup>
|
||
|
|
<thead valign="bottom">
|
||
|
|
<tr class="row-odd"><th class="head">Value</th>
|
||
|
|
<th class="head">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">contain</span></code></td>
|
||
|
|
<td>As large as possible, without exceeding any dimensions.
|
||
|
|
Maintains aspect ratio.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">cover</span></code></td>
|
||
|
|
<td>As small as possible, while matching or exceeding all
|
||
|
|
dimensions. Maintains aspect ratio.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td>None or <code class="docutils literal notranslate"><span class="pre">fill</span></code></td>
|
||
|
|
<td>Stretches/squashes displayable to exactly match dimensions.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">scale-down</span></code></td>
|
||
|
|
<td>As for <code class="docutils literal notranslate"><span class="pre">contain</span></code>, but will never increase the size of the
|
||
|
|
displayable.</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">scale-up</span></code></td>
|
||
|
|
<td>As for <code class="docutils literal notranslate"><span class="pre">cover</span></code>, but will never decrease the size of the
|
||
|
|
displayable.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-subpixel">
|
||
|
|
<code class="descname">subpixel</code><a class="headerlink" href="#transform-property-subpixel" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">False</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If True, causes the child to be placed using subpixel positioning.</p>
|
||
|
|
<p>Subpixel positioning effects the colors (including transparency)
|
||
|
|
that are drawn into pixels, but not which pixels are drawn. When
|
||
|
|
subpixel positoning is used in combination with movement (the usual
|
||
|
|
case), the image should have transparent borders in the directions
|
||
|
|
it might be moved in, if those edges are visible on the screen.</p>
|
||
|
|
<p>For example, if a character sprite is being moved horizontally,
|
||
|
|
it makes sense to have transparent borders on the left and right.
|
||
|
|
These might not be necessary when panning over a background that
|
||
|
|
extends outside the visible area, as the edges will not be seen.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-delay">
|
||
|
|
<code class="descname">delay</code><a class="headerlink" href="#transform-property-delay" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">0.0</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If this transform is being used as a transition, then this is the
|
||
|
|
duration of the transition.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-events">
|
||
|
|
<code class="descname">events</code><a class="headerlink" href="#transform-property-events" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">True</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If true, events are passed to the child of this transform. If false,
|
||
|
|
events are blocked. (This can be used in ATL transforms to prevent
|
||
|
|
events from reaching the old_widget.)</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xpan">
|
||
|
|
<code class="descname">xpan</code><a class="headerlink" href="#transform-property-xpan" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, this interpreted as an angle that is used to pan horizontally
|
||
|
|
across a 360 degree panoramic image. The center of the image is used as the
|
||
|
|
zero angle, while the left and right edges are -180 and 180 degrees,
|
||
|
|
respectively.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-ypan">
|
||
|
|
<code class="descname">ypan</code><a class="headerlink" href="#transform-property-ypan" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, this interpreted as an angle that is used to pan vertically
|
||
|
|
across a 360 degree panoramic image. The center of the image is used as the
|
||
|
|
zero angle, while the top and bottom edges are -180 and 180 degrees,
|
||
|
|
respectively.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-xtile">
|
||
|
|
<code class="descname">xtile</code><a class="headerlink" href="#transform-property-xtile" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">1</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The number of times to tile the image horizontally.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-ytile">
|
||
|
|
<code class="descname">ytile</code><a class="headerlink" href="#transform-property-ytile" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">1</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>The number of times to tile the image vertically.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-matrixcolor">
|
||
|
|
<code class="descname">matrixcolor</code><a class="headerlink" href="#transform-property-matrixcolor" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or Matrix or MatrixColor</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, the value of this property is used to recolor everything
|
||
|
|
that children of this transform draw. Interpolation is only supported
|
||
|
|
when MatrixColors are used, and the MatrixColors are structurally similar.
|
||
|
|
See <a class="reference internal" href="matrixcolor.html"><span class="doc">Matrixcolor</span></a> for more information.</p>
|
||
|
|
<p>This requires model-based rendering to be enabled by setting <a class="reference internal" href="model.html#var-config.gl2"><code class="xref std std-var docutils literal notranslate"><span class="pre">config.gl2</span></code></a> to
|
||
|
|
True.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-blur">
|
||
|
|
<code class="descname">blur</code><a class="headerlink" href="#transform-property-blur" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or float</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This blurs the child of this transform by <cite>blur</cite> pixels, up to the border
|
||
|
|
of the displayable. The precise details of the blurring may change
|
||
|
|
between Ren'Py versions, and the blurring may exhibit artifacts,
|
||
|
|
especially when the image being blurred is changing.</p>
|
||
|
|
<p>This requires model-based rendering to be enabled by setting <a class="reference internal" href="model.html#var-config.gl2"><code class="xref std std-var docutils literal notranslate"><span class="pre">config.gl2</span></code></a> to
|
||
|
|
True.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<p>There are also several sets of transform properties that are documented elsewhere:</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>3D Stage properties:</dt>
|
||
|
|
<dd><a class="reference internal" href="3dstage.html#transform-property-perspective"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">perspective</span></code></a>, <a class="reference internal" href="3dstage.html#transform-property-matrixanchor"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">matrixanchor</span></code></a>, <a class="reference internal" href="3dstage.html#transform-property-matrixtransform"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">matrixtransform</span></code></a>, <a class="reference internal" href="3dstage.html#transform-property-zpos"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">zpos</span></code></a>, <a class="reference internal" href="3dstage.html#transform-property-zzoom"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">zzoom</span></code></a></dd>
|
||
|
|
<dt>Model-based rendering properties:</dt>
|
||
|
|
<dd><a class="reference internal" href="model.html#transform-property-blend"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">blend</span></code></a>, <a class="reference internal" href="model.html#transform-property-mesh"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">mesh</span></code></a>, <a class="reference internal" href="model.html#transform-property-mesh_pad"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">mesh_pad</span></code></a>, <a class="reference internal" href="model.html#transform-property-shader"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">shader</span></code></a></dd>
|
||
|
|
<dt>GL Properties:</dt>
|
||
|
|
<dd>The <a class="reference internal" href="model.html#gl-properties"><span class="std std-ref">GL properties</span></a>.</dd>
|
||
|
|
<dt>Uniforms:</dt>
|
||
|
|
<dd>Properties beginning with <code class="docutils literal notranslate"><span class="pre">u_</span></code> are uniforms that can be used by <a class="reference internal" href="model.html#custom-shaders"><span class="std std-ref">custom shaders</span></a>.</dd>
|
||
|
|
</dl>
|
||
|
|
<p>These properties are applied in the following order:</p>
|
||
|
|
<ol class="arabic simple">
|
||
|
|
<li>mesh, blur</li>
|
||
|
|
<li>tile</li>
|
||
|
|
<li>pan</li>
|
||
|
|
<li>crop, corner1, corner2</li>
|
||
|
|
<li>xysize, size, maxsize</li>
|
||
|
|
<li>zoom, xzoom, yzoom</li>
|
||
|
|
<li>rotate</li>
|
||
|
|
<li>zpos</li>
|
||
|
|
<li>matrixtransform, matrixanchor</li>
|
||
|
|
<li>zzoom</li>
|
||
|
|
<li>perspective</li>
|
||
|
|
<li>nearest, blend, alpha, additive, shader.</li>
|
||
|
|
<li>matrixcolor</li>
|
||
|
|
<li>GL Properties, Uniforms</li>
|
||
|
|
<li>position properties</li>
|
||
|
|
</ol>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="deprecated-transform-properties">
|
||
|
|
<h2>Deprecated Transform Properties<a class="headerlink" href="#deprecated-transform-properties" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<div class="admonition warning">
|
||
|
|
<p class="first admonition-title">Warning</p>
|
||
|
|
<p class="last">The following properties should not be used in modern games, as they may
|
||
|
|
conflict with more recent features. They are only kept here for compatibility,
|
||
|
|
along with the new way of achieving the same behavior.</p>
|
||
|
|
</div>
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-crop_relative">
|
||
|
|
<code class="descname">crop_relative</code><a class="headerlink" href="#transform-property-crop_relative" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">True</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If False, float components of <a class="reference internal" href="#transform-property-crop"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">crop</span></code></a> are interpreted as an absolute
|
||
|
|
number of pixels, instead of a fraction of the width and height of
|
||
|
|
the source image.</p>
|
||
|
|
<p>If an absolute number of pixel is to be expressed, <code class="docutils literal notranslate"><span class="pre">absolute</span></code> instances
|
||
|
|
should be provided to the <a class="reference internal" href="#transform-property-crop"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">crop</span></code></a> property instead of using the
|
||
|
|
crop_relative property. If necessary, values of dubious type can be wrapped
|
||
|
|
in the <code class="docutils literal notranslate"><span class="pre">absolute</span></code> callable.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-size">
|
||
|
|
<code class="descname">size</code><a class="headerlink" href="#transform-property-size" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or (int, int)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>This is an older version of <a class="reference internal" href="#transform-property-xysize"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xysize</span></code></a> interpreting floating-point values
|
||
|
|
as an absolute number of pixels.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="transform-property">
|
||
|
|
<dt id="transform-property-maxsize">
|
||
|
|
<code class="descname">maxsize</code><a class="headerlink" href="#transform-property-maxsize" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">None or (int, int)</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Default:</th><td class="field-body">None</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>If not None, causes the displayable to be scaled so that it fits
|
||
|
|
within a box of this size, while preserving aspect ratio. (Note that
|
||
|
|
this means that one of the dimensions may be smaller than the size
|
||
|
|
of this box.)</p>
|
||
|
|
<p>To achieve the same result, give the values to the <a class="reference internal" href="#transform-property-xysize"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xysize</span></code></a> property, and
|
||
|
|
set the <a class="reference internal" href="#transform-property-fit"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">fit</span></code></a> property to the value "contain".</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="circular-motion">
|
||
|
|
<h2>Circular Motion<a class="headerlink" href="#circular-motion" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>When an interpolation statement contains the <code class="docutils literal notranslate"><span class="pre">clockwise</span></code> or
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">counterclockwise</span></code> keywords, the interpolation will cause circular motion.
|
||
|
|
Ren'Py will compare the start and end locations and figure out the polar
|
||
|
|
coordinate center. Ren'Py will then compute the number of degrees it will
|
||
|
|
take to go from the start angle to the end angle, in the specified direction
|
||
|
|
of rotation. If the circles clause is given, Ren'Py will ensure that the
|
||
|
|
appropriate number of circles will be made.</p>
|
||
|
|
<p>Ren'Py will then interpolate the angle and radius properties, as appropriate,
|
||
|
|
to cause the circular motion to happen. If the transform is in align mode,
|
||
|
|
setting the angle and radius will set the align property. Otherwise, the pos
|
||
|
|
property will be set.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="external-events">
|
||
|
|
<h2>External Events<a class="headerlink" href="#external-events" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>The following events can be triggered automatically:</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">start</span></code></dt>
|
||
|
|
<dd>A pseudo-event, triggered on entering an <code class="docutils literal notranslate"><span class="pre">on</span></code> statement, if no event of
|
||
|
|
higher priority has happened.</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">show</span></code></dt>
|
||
|
|
<dd>Triggered when the transform is shown using the show or scene
|
||
|
|
statement, and no image with the given tag exists.</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">replace</span></code></dt>
|
||
|
|
<dd>Triggered when transform is shown using the <code class="docutils literal notranslate"><span class="pre">show</span></code> statement, replacing
|
||
|
|
an image with the given tag.</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">hide</span></code></dt>
|
||
|
|
<dd><p class="first">Triggered when the transform is hidden using the <code class="docutils literal notranslate"><span class="pre">hide</span></code> statement or its
|
||
|
|
Python equivalent.</p>
|
||
|
|
<p class="last">Note that this isn't triggered when the transform is eliminated via
|
||
|
|
the scene statement or exiting the context it exists in, such as when
|
||
|
|
exiting the game menu.</p>
|
||
|
|
</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">replaced</span></code></dt>
|
||
|
|
<dd>Triggered when the transform is replaced by another. The image will
|
||
|
|
not actually hide until the ATL block finishes.</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">update</span></code></dt>
|
||
|
|
<dd>Triggered when a screen is updated without being shown or replacing
|
||
|
|
another screen. This happens in rare but possible cases, such as when
|
||
|
|
the game is loaded and when styles or translations change.</dd>
|
||
|
|
<dt><code class="docutils literal notranslate"><span class="pre">hover</span></code>, <code class="docutils literal notranslate"><span class="pre">idle</span></code>, <code class="docutils literal notranslate"><span class="pre">selected_hover</span></code>, <code class="docutils literal notranslate"><span class="pre">selected_idle</span></code></dt>
|
||
|
|
<dd>Triggered when button containing this transform, or a button contained
|
||
|
|
by this transform, enters the named state.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="replacing-transforms">
|
||
|
|
<span id="id3"></span><h2>Replacing Transforms<a class="headerlink" href="#replacing-transforms" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>When an an ATL transform or transform defined using the <a class="reference internal" href="trans_trans_python.html#Transform" title="Transform"><code class="xref py py-func docutils literal notranslate"><span class="pre">Transform()</span></code></a> class
|
||
|
|
is replaced by another class, the properties of the transform that's being
|
||
|
|
replaced are inherited by the transform that's replacing it.</p>
|
||
|
|
<p>When the <code class="docutils literal notranslate"><span class="pre">show</span></code> statement has multiple transforms in the at list, the
|
||
|
|
transforms are matched from last to first, until one list runs out. For
|
||
|
|
example, in:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">show</span> <span class="n">eileen</span> <span class="n">happy</span> <span class="k">at</span> <span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span>
|
||
|
|
<span class="s2">"Let's wait a bit."</span>
|
||
|
|
<span class="k">show</span> <span class="n">eileen</span> <span class="n">happy</span> <span class="k">at</span> <span class="n">d</span><span class="p">,</span> <span class="n">e</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>the <code class="docutils literal notranslate"><span class="pre">c</span></code> transform is replaced by <code class="docutils literal notranslate"><span class="pre">e</span></code>, the <code class="docutils literal notranslate"><span class="pre">b</span></code> transform is replaced by
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">d</span></code>, and nothing replaces the <code class="docutils literal notranslate"><span class="pre">a</span></code> transform.</p>
|
||
|
|
<p>At the moment of replacement, the values of the properties of the old transform
|
||
|
|
get inherited by the new transform. If the old transform was being animated,
|
||
|
|
this might mean an intermediate value is inherited. For example:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">bounce</span><span class="p">:</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">3.0</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="mf">3.0</span> <span class="na">xalign</span> <span class="mf">0.0</span>
|
||
|
|
<span class="k">repeat</span>
|
||
|
|
|
||
|
|
<span class="k">transform</span> <span class="n">headright</span><span class="p">:</span>
|
||
|
|
<span class="n">linear</span> <span class="mi">15</span> <span class="na">xalign</span> <span class="mf">1.0</span>
|
||
|
|
|
||
|
|
<span class="k">label</span> <span class="n">example</span><span class="p">:</span>
|
||
|
|
<span class="k">show</span> <span class="n">eileen</span> <span class="n">happy</span> <span class="k">at</span> <span class="n">bounce</span>
|
||
|
|
<span class="k">pause</span>
|
||
|
|
<span class="k">show</span> <span class="n">eileen</span> <span class="n">happy</span> <span class="k">at</span> <span class="n">headright</span>
|
||
|
|
<span class="k">pause</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>In this example, the sprite will bounce from left to right and back until
|
||
|
|
the player clicks. When that happens, the <code class="docutils literal notranslate"><span class="pre">xalign</span></code> from <code class="docutils literal notranslate"><span class="pre">bounce</span></code> will
|
||
|
|
be used to initialize the <code class="docutils literal notranslate"><span class="pre">xalign</span></code> of headright, and so the sprite
|
||
|
|
will move from where it was when the player first clicked.</p>
|
||
|
|
<p>The position properties (<a class="reference internal" href="#transform-property-xpos"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xpos</span></code></a>, <a class="reference internal" href="#transform-property-ypos"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">ypos</span></code></a>, <a class="reference internal" href="#transform-property-xanchor"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xanchor</span></code></a>, and <a class="reference internal" href="#transform-property-yanchor"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">yanchor</span></code></a>),
|
||
|
|
have a special rule for inheritance - a value set in the child will override a value set
|
||
|
|
in the parent. This is because a displayable may have only one position, and
|
||
|
|
a position that is actively set takes precedence. These properties may be set in
|
||
|
|
multiple ways - for example, <a class="reference internal" href="#transform-property-xalign"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">xalign</span></code></a> sets xpos and xanchor.</p>
|
||
|
|
<p>Finally, when a <code class="docutils literal notranslate"><span class="pre">show</span></code> statement does not include an <code class="docutils literal notranslate"><span class="pre">at</span></code> clause, the
|
||
|
|
same displayables are used, so no inheritence is necessary. To prevent inheritance,
|
||
|
|
show and then hide the displayable.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="atl-transitions">
|
||
|
|
<span id="id4"></span><h2>ATL Transitions<a class="headerlink" href="#atl-transitions" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>It's possible to use an ATL transform to define a transition. These transitions
|
||
|
|
accept the <cite>old_widget</cite> and <cite>new_widget</cite> arguments, which are given displayables
|
||
|
|
that are transitioned from and to, respectively.</p>
|
||
|
|
<p>An ATL transition must set the <a class="reference internal" href="#transform-property-delay"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">delay</span></code></a> property to the number of seconds
|
||
|
|
the transition lasts for. It may user the <a class="reference internal" href="#transform-property-events"><code class="xref std std-tpref docutils literal notranslate"><span class="pre">events</span></code></a> property to prevent
|
||
|
|
the old displayable from receiving events.</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">spin</span><span class="p">(</span><span class="n">duration</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">new_widget</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">old_widget</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||
|
|
|
||
|
|
<span class="c1"># Set how long this transform will take to complete.</span>
|
||
|
|
<span class="na">delay</span> <span class="n">duration</span>
|
||
|
|
|
||
|
|
<span class="c1"># Center it.</span>
|
||
|
|
<span class="na">xcenter</span> <span class="mf">0.5</span>
|
||
|
|
<span class="na">ycenter</span> <span class="mf">0.5</span>
|
||
|
|
|
||
|
|
<span class="c1"># Spin the old displayable.</span>
|
||
|
|
<span class="n">old_widget</span>
|
||
|
|
<span class="na">events</span> <span class="kc">False</span>
|
||
|
|
<span class="na">rotate</span> <span class="mf">0.0</span>
|
||
|
|
<span class="n">easeout</span> <span class="p">(</span><span class="n">duration</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="na">rotate</span> <span class="mf">360.0</span>
|
||
|
|
|
||
|
|
<span class="c1"># Spin the new displayable.</span>
|
||
|
|
<span class="n">new_widget</span>
|
||
|
|
<span class="na">events</span> <span class="kc">True</span>
|
||
|
|
<span class="n">easein</span> <span class="p">(</span><span class="n">duration</span> <span class="o">/</span> <span class="mi">2</span><span class="p">)</span> <span class="na">rotate</span> <span class="mf">720.0</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="special-atl-keyword-parameters">
|
||
|
|
<span id="atl-keyword-parameters"></span><h2>Special ATL Keyword Parameters<a class="headerlink" href="#special-atl-keyword-parameters" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>There are several parameters that Ren'Py will supply to ATL, in certain
|
||
|
|
contexts, if the parameter is in the parameter list.</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt><cite>child</cite></dt>
|
||
|
|
<dd><p class="first">When ATL is used as a transform, the child parameter is given the original
|
||
|
|
child that the transform is applied to. This allows the child to be referred
|
||
|
|
to explicitly. For example, it becomes possible to swap between the supplied
|
||
|
|
child and another displayable:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">lucy_jump_scare</span><span class="p">(</span><span class="na">child</span><span class="p">):</span>
|
||
|
|
<span class="na">child</span> <span class="c1"># Show the original child.</span>
|
||
|
|
<span class="k">pause</span> <span class="mi">5</span>
|
||
|
|
<span class="s2">"lucy mad"</span> <span class="c1"># Jump scare.</span>
|
||
|
|
<span class="k">pause</span> <span class="o">.</span><span class="mi">2</span>
|
||
|
|
<span class="na">child</span> <span class="c1"># Go back to the original child.</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>If can also be used to place the original child inside a <code class="docutils literal notranslate"><span class="pre">contains</span></code>
|
||
|
|
block:</p>
|
||
|
|
<div class="last highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">transform</span> <span class="n">marquee</span><span class="p">(</span><span class="na">width</span><span class="p">,</span> <span class="na">height</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">duration</span><span class="o">=</span><span class="mf">2.0</span><span class="p">,</span> <span class="na">child</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||
|
|
<span class="na">xcenter</span> <span class="mf">0.5</span>
|
||
|
|
<span class="na">ycenter</span> <span class="mf">0.5</span>
|
||
|
|
|
||
|
|
<span class="na">crop_relative</span> <span class="kc">True</span>
|
||
|
|
<span class="na">crop</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mi">500</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="k">contains</span><span class="p">:</span>
|
||
|
|
<span class="na">child</span>
|
||
|
|
<span class="na">xanchor</span> <span class="mf">0.0</span> <span class="na">xpos</span> <span class="mf">1.0</span>
|
||
|
|
<span class="n">linear</span> <span class="n">duration</span> <span class="na">xanchor</span> <span class="mf">1.0</span> <span class="na">xpos</span> <span class="mf">0.0</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
<dt><cite>old_widget</cite>, <cite>new_widget</cite></dt>
|
||
|
|
<dd>When an ATL block is used as a transition, these are given displayables
|
||
|
|
that are transitioned from and to, respectively.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer class="footer">
|
||
|
|
<div class="container">
|
||
|
|
<p class="pull-right">
|
||
|
|
<a href="#">Back to top</a>
|
||
|
|
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
© Copyright 2012-2022, Tom Rothamel.<br/>
|
||
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.6.<br/>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
</body>
|
||
|
|
</html>
|