356 lines
22 KiB
HTML
356 lines
22 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>Self-Voicing — 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="Text Editor Integration" href="editor.html" />
|
||
|
|
<link rel="prev" title="Environment Variables" href="environment_variables.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>
|
||
|
|
<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"><a class="reference internal" href="atl.html">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 class="current">
|
||
|
|
<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 current"><a class="current reference internal" href="#">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="#">Self-Voicing</a><ul>
|
||
|
|
<li><a class="reference internal" href="#speech-synthesis">Speech Synthesis</a></li>
|
||
|
|
<li><a class="reference internal" href="#creator-concerns">Creator Concerns</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-md-9 content">
|
||
|
|
|
||
|
|
<div class="section" id="self-voicing">
|
||
|
|
<span id="id1"></span><h1>Self-Voicing<a class="headerlink" href="#self-voicing" title="Permalink to this headline"> link</a></h1>
|
||
|
|
<p>Ren'Py supports a self-voicing mode in which a speech synthesizer is used
|
||
|
|
to read out text and other interface elements. This is intended to make
|
||
|
|
Ren'Py games accessible to the vision impaired.</p>
|
||
|
|
<p>The Self-voicing mode can be toggled by pressing the <code class="docutils literal notranslate"><span class="pre">v</span></code> key.</p>
|
||
|
|
<p>When in self-voicing mode, keyboard navigation is changed so that the
|
||
|
|
up and down arrow keys with iterate through all focusable displayables
|
||
|
|
on the screen.</p>
|
||
|
|
<p>When a displayable is focused, Ren'Py will read the text associated with that
|
||
|
|
displayable out loud. If no displayable is focused, Ren'Py will read on-screen
|
||
|
|
text that cannot be focused. This will generally include dialogue and other
|
||
|
|
text that comprises the game.</p>
|
||
|
|
<div class="section" id="speech-synthesis">
|
||
|
|
<h2>Speech Synthesis<a class="headerlink" href="#speech-synthesis" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>Ren'Py relies on the operating system to provide speech synthesis
|
||
|
|
services. To adjust the speed of speech synthesis and the voice used,
|
||
|
|
adjust your platform's speech settings.</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>Windows</dt>
|
||
|
|
<dd>On Windows, Ren'Py uses the Microsoft Speech API. Speech synthesis
|
||
|
|
settings can be changed on the "Text to Speech" tab of the "Speech
|
||
|
|
Recognition" control panel.</dd>
|
||
|
|
<dt>Mac OS X</dt>
|
||
|
|
<dd>On Mac OS X, Ren'Py uses the <code class="docutils literal notranslate"><span class="pre">say</span></code> command. Speech synthesis settings
|
||
|
|
can be changed on the "Text to Speech" tab of the "Dictation & Speech"
|
||
|
|
control panel.</dd>
|
||
|
|
<dt>Linux</dt>
|
||
|
|
<dd>On Linux, Ren'Py uses the <code class="docutils literal notranslate"><span class="pre">espeak</span></code> command. Espeak may need to be
|
||
|
|
installed using your package manager before self-voicing mode will
|
||
|
|
work.</dd>
|
||
|
|
<dt>Android, iOS, Chrome OS</dt>
|
||
|
|
<dd>Self-voicing mode is not supported on Android, iOS, or Chrome OS.</dd>
|
||
|
|
</dl>
|
||
|
|
<p>The default voice can be selected on a per-platform basis, using the
|
||
|
|
<a class="reference internal" href="config.html#var-config.tts_voice"><code class="xref std std-var docutils literal notranslate"><span class="pre">config.tts_voice</span></code></a> variable. For example:</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">if</span> <span class="n">renpy</span><span class="o">.</span><span class="n">windows</span><span class="p">:</span>
|
||
|
|
<span class="n">config</span><span class="o">.</span><span class="n">tts_voice</span> <span class="o">=</span> <span class="s2">"Mark"</span>
|
||
|
|
<span class="k">elif</span> <span class="n">renpy</span><span class="o">.</span><span class="n">macintosh</span><span class="p">:</span>
|
||
|
|
<span class="n">config</span><span class="o">.</span><span class="n">tts_voice</span> <span class="o">=</span> <span class="s2">"Alex"</span>
|
||
|
|
<span class="k">elif</span> <span class="n">renpy</span><span class="o">.</span><span class="n">linux</span><span class="p">:</span>
|
||
|
|
<span class="n">config</span><span class="o">.</span><span class="n">tts_voice</span> <span class="o">=</span> <span class="s2">"english_rp"</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>The available voice vary based on the platform.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="creator-concerns">
|
||
|
|
<h2>Creator Concerns<a class="headerlink" href="#creator-concerns" title="Permalink to this headline"> link</a></h2>
|
||
|
|
<p>Ren'Py's self-voicing works by extracting text from displayables and
|
||
|
|
reading it to the player. Ren'Py extracts this text from two places.</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>Text displayables</dt>
|
||
|
|
<dd>Ren'Py will extract text from a Text displayable, and make it
|
||
|
|
available to be read to the player.</dd>
|
||
|
|
<dt>Alternative text</dt>
|
||
|
|
<dd><p class="first">Alternative text is supplied by a displayable's <a class="reference internal" href="style_properties.html#style-property-alt"><code class="xref std std-propref docutils literal notranslate"><span class="pre">alt</span></code></a> style
|
||
|
|
property. It can also be supplied by actions supplied to buttons
|
||
|
|
and values supplied to bars. Explicitly supplied alternative takes
|
||
|
|
precedence over text supplied by actions or values, and both take
|
||
|
|
precedence over text extracted from Text displayables.</p>
|
||
|
|
<p>Alternative text is translated using Ren'Py's string translation
|
||
|
|
mechanism. Alternative text takes precedence over text extracted
|
||
|
|
from a displayable and its children, but such child text is made
|
||
|
|
available as the "[text]" string substitution. No other string
|
||
|
|
substitutions are allowed.</p>
|
||
|
|
<p>For example:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">screen</span> <span class="n">information</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">planet</span><span class="p">,</span> <span class="n">badness</span><span class="p">):</span>
|
||
|
|
<span class="k">text</span> <span class="n">message</span><span class="p">:</span>
|
||
|
|
<span class="na">color</span> <span class="n">color_from_badness</span><span class="p">(</span><span class="n">badness</span><span class="p">)</span>
|
||
|
|
<span class="na">alt</span> <span class="s2">"Information for you : [text]. Badness is "</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">badness</span><span class="p">)</span>
|
||
|
|
|
||
|
|
<span class="k">text</span> <span class="s2">"ORIGIN_OF_MESSAGE_{color=#f00}[planet!u]{/color}"</span><span class="p">:</span>
|
||
|
|
<span class="na">alt</span> <span class="s2">"Origin of message is "</span> <span class="o">+</span> <span class="n">planet</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>In the above example, the <code class="docutils literal notranslate"><span class="pre">badness</span></code> and <code class="docutils literal notranslate"><span class="pre">planet</span></code> variables
|
||
|
|
cannot be substituted directly using "[badness]". Concatenating
|
||
|
|
it manually is a solution.</p>
|
||
|
|
<p>Supplying the <cite>who_alt</cite> and <cite>what_alt</cite> parameters to Character
|
||
|
|
sets the alt style property for the character name and body text,
|
||
|
|
respectively. As an example, we define a Character that uses italics
|
||
|
|
to indicate thoughts normally, but explicitly indicates thoughts
|
||
|
|
via self voicing:</p>
|
||
|
|
<div class="last highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="n">thought</span> <span class="o">=</span> <span class="n">Character</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">what_italic</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">what_alt</span><span class="o">=</span><span class="s2">"I think, [text]"</span><span class="p">)</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
<dt>Descriptive Text</dt>
|
||
|
|
<dd><p class="first">Descriptive text is text that is displayed (and spoken) by the narrator if
|
||
|
|
self-voicing is enabled. The text is not displayed if self-voicing is
|
||
|
|
disabled. Self-voicing text uses the <a class="reference internal" href="#var-alt"><code class="xref std std-var docutils literal notranslate"><span class="pre">alt</span></code></a> variable, which is defined to
|
||
|
|
be similar to a character.</p>
|
||
|
|
<dl class="var">
|
||
|
|
<dt id="var-alt">
|
||
|
|
<code class="descname">alt</code> = ...<a class="headerlink" href="#var-alt" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><p>A character-like object that uses the narrator to speak text if
|
||
|
|
self-voicing is enabled.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<p>For example:</p>
|
||
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="n">e</span> <span class="s2">"Hang on, this is gonna be a bumpy ride!"</span>
|
||
|
|
|
||
|
|
<span class="na">alt</span> <span class="s2">"And then the sun exploded..."</span>
|
||
|
|
|
||
|
|
<span class="c1"># A complex and exciting cut scene.</span>
|
||
|
|
<span class="k">show</span> <span class="k">event</span> <span class="n">sun_exploding</span>
|
||
|
|
<span class="k">pause</span> <span class="mi">10</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>There is a variable that controls descriptive text:</p>
|
||
|
|
<dl class="last var">
|
||
|
|
<dt id="var-config.descriptive_text_character">
|
||
|
|
define <code class="descname">config.descriptive_text_character</code> = None<a class="headerlink" href="#var-config.descriptive_text_character" title="Permalink to this definition"> link</a></dt>
|
||
|
|
<dd><p>If not None, this should be a character object that is used to
|
||
|
|
display the descriptive text, instead of the narrator.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>A self-voicing debug mode can be enabled by typing Shift+Alt+V. This will
|
||
|
|
display the text that would be voiced on the screen for development
|
||
|
|
purposes.</p>
|
||
|
|
</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>
|