351 lines
21 KiB
HTML
351 lines
21 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>In-Game Menus — 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="Python Statements" href="python.html" />
|
|
<link rel="prev" title="Displaying Images" href="displaying_images.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 class="current">
|
|
<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 current"><a class="current reference internal" href="#">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>
|
|
<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="#">In-Game Menus</a><ul>
|
|
<li><a class="reference internal" href="#menu-set">Menu Set</a></li>
|
|
<li><a class="reference internal" href="#menu-arguments">Menu Arguments</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="col-md-9 content">
|
|
|
|
<div class="section" id="in-game-menus">
|
|
<span id="menus"></span><h1>In-Game Menus<a class="headerlink" href="#in-game-menus" title="Permalink to this headline"> link</a></h1>
|
|
<p>In many visual novels, the player is asked to make choices that
|
|
control the outcome of the story. The Ren'Py language contains a <code class="docutils literal notranslate"><span class="pre">menu</span></code>
|
|
statement that makes it easy to present choices to the user.</p>
|
|
<p>Here's an example of a <code class="docutils literal notranslate"><span class="pre">menu</span></code> statement:</p>
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">menu</span><span class="p">:</span>
|
|
<span class="s2">"What should I do?"</span>
|
|
|
|
<span class="s2">"Drink coffee."</span><span class="p">:</span>
|
|
<span class="s2">"I drink the coffee, and it's good to the last drop."</span>
|
|
|
|
<span class="s2">"Drink tea."</span><span class="p">:</span>
|
|
<span class="k">$</span> <span class="n">drank_tea</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
|
<span class="s2">"I drink the tea, trying not to make a political statement as I do."</span>
|
|
|
|
<span class="s2">"Genuflect."</span><span class="p">:</span>
|
|
<span class="k">jump</span> <span class="n">genuflect_ending</span>
|
|
|
|
<span class="k">label</span> <span class="n">after_menu</span><span class="p">:</span>
|
|
|
|
<span class="s2">"After having my drink, I got on with my morning."</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">menu</span></code> statement begins with the keyword <code class="docutils literal notranslate"><span class="pre">menu</span></code>. This may be followed
|
|
by a label name, in which case it's equivalent to preceding the menu
|
|
with that label. For example:</p>
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">menu</span> <span class="n">drink_menu</span><span class="p">:</span>
|
|
<span class="o">...</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The menu statement is followed by an indented block. This block may
|
|
contain a <a class="reference internal" href="dialogue.html#say-statement"><span class="std std-ref">say statement</span></a>, and must contain at
|
|
least one menu choice. If the say statement is present, it is
|
|
displayed on the screen at the same time as the menu.</p>
|
|
<p><strong>Menu Choices.</strong>
|
|
A menu choice is an option the user can select from the in-game
|
|
menu. A menu choice begins with a string. The string may be followed
|
|
by an if-clause, which makes the choice conditional. The menu choice
|
|
ends with a colon, and must be followed by a block of Ren'Py
|
|
statements.</p>
|
|
<p>When the choice is selected, the block of statements is run. If execution
|
|
reaches the end of the block, it continues with the statement
|
|
after the end of the menu statement.</p>
|
|
<p>An if-clause consists of the keyword <code class="docutils literal notranslate"><span class="pre">if</span></code>, followed by a Python
|
|
expression. The menu choice is only displayed if the expression is
|
|
true. In the following menu:</p>
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">menu</span><span class="p">:</span>
|
|
<span class="s2">"Go left."</span><span class="p">:</span>
|
|
<span class="o">...</span>
|
|
<span class="s2">"Go right."</span><span class="p">:</span>
|
|
<span class="o">...</span>
|
|
<span class="s2">"Fly above."</span> <span class="k">if</span> <span class="n">drank_tea</span><span class="p">:</span>
|
|
<span class="o">...</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>The third choice will only be presented if the <code class="docutils literal notranslate"><span class="pre">drank_tea</span></code> variable is
|
|
true. (However if, the <a class="reference internal" href="config.html#var-config.menu_include_disabled"><code class="xref std std-var docutils literal notranslate"><span class="pre">config.menu_include_disabled</span></code></a> variable is set
|
|
to True, it will be shown as a disabled button.)</p>
|
|
<div class="section" id="menu-set">
|
|
<span id="id1"></span><h2>Menu Set<a class="headerlink" href="#menu-set" title="Permalink to this headline"> link</a></h2>
|
|
<p>A menu can take a set clause, on a line by itself. If present, only items
|
|
with captions that are not in the set are displayed as part of the menu.
|
|
When a choice is selected, the caption of that choice can be added to the
|
|
set.</p>
|
|
<p>As with all menus, if no choices are available it advances to the statement
|
|
after the menu.</p>
|
|
<p>For historical reasons, the set can be either a set object or a list.</p>
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">default</span> <span class="n">menuset</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
|
|
|
<span class="k">menu</span> <span class="n">chapter_1_places</span><span class="p">:</span>
|
|
|
|
<span class="nb">set</span> <span class="n">menuset</span>
|
|
<span class="s2">"Where should I go?"</span>
|
|
|
|
<span class="s2">"Go to class."</span><span class="p">:</span>
|
|
<span class="k">jump</span> <span class="n">go_to_class</span>
|
|
|
|
<span class="s2">"Go to the bar."</span><span class="p">:</span>
|
|
<span class="k">jump</span> <span class="n">go_to_bar</span>
|
|
|
|
<span class="s2">"Go to jail."</span><span class="p">:</span>
|
|
<span class="k">jump</span> <span class="n">go_to_jail</span>
|
|
|
|
<span class="k">label</span> <span class="n">chapter_1_after_places</span><span class="p">:</span>
|
|
|
|
<span class="s2">"Wow, that was one heck of a Tuesday."</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="menu-arguments">
|
|
<span id="id2"></span><h2>Menu Arguments<a class="headerlink" href="#menu-arguments" title="Permalink to this headline"> link</a></h2>
|
|
<p>It's possible to pass arguments to the menu itself, and to the individual
|
|
choices in a menu. To pass arguments to the menu, add them to the
|
|
menu line, after the optional name, and immediately before the colon. To
|
|
pass arguments to a menu choice, put them after the menu string and before
|
|
the <code class="docutils literal notranslate"><span class="pre">if</span></code> keyword or colon.</p>
|
|
<div class="highlight-renpy notranslate"><div class="highlight"><pre><span></span><span class="k">menu</span> <span class="p">(</span><span class="s2">"jfk"</span><span class="p">,</span> <span class="k">screen</span><span class="o">=</span><span class="s2">"airport"</span><span class="p">):</span>
|
|
|
|
<span class="s2">"Chicago, IL"</span> <span class="p">(</span><span class="mi">200</span><span class="p">):</span>
|
|
<span class="k">jump</span> <span class="n">chicago_trip</span>
|
|
|
|
<span class="s2">"Dallas, TX"</span> <span class="p">(</span><span class="mi">150</span><span class="p">,</span> <span class="n">sale</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
|
|
<span class="k">jump</span> <span class="n">dallas_trip</span>
|
|
|
|
<span class="s2">"Hot Springs, AR"</span> <span class="p">(</span><span class="mi">300</span><span class="p">)</span> <span class="k">if</span> <span class="n">secret_unlocked</span><span class="p">:</span>
|
|
<span class="k">jump</span> <span class="n">hot_springs_trip</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Menu arguments passed to the menu itself become arguments to the screen,
|
|
except the <cite>screen</cite> argument which selects the screen, and the <cite>nvl</cite> argument
|
|
that selects the <a class="reference internal" href="nvl_mode.html#nvl-mode-menu"><span class="std std-ref">NVL-mode menu</span></a>. There is also a special
|
|
keyword <cite>_mode</cite> which will set the mode of this interaction, by default "menu".
|
|
The arguments to the choices become arguments to the items passed to the
|
|
menu screen.</p>
|
|
<p>See the documentation for <a class="reference internal" href="screen_special.html#choice-screen"><span class="std std-ref">the choice screen</span></a> and
|
|
<a class="reference internal" href="config.html#var-config.menu_arguments_callback"><code class="xref std std-var docutils literal notranslate"><span class="pre">config.menu_arguments_callback</span></code></a>.</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> |