/usr/share/doc/renpy/html/input.html is in renpy-doc 6.17.6-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 | <!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Text Input — Ren'Py Documentation</title>
<link rel="stylesheet" href="_static/screen.css" type="text/css" media="screen, projection"/>
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" media="print" />
<!--[if lt IE 8]>
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" media="screen, projection"/>
<![endif]-->
<link rel="stylesheet" href="_static/renpydoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '6.18.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Ren'Py Documentation" href="index.html" />
<link rel="next" title="Side Images" href="side_image.html" />
<link rel="prev" title="NVL-Mode Tutorial" href="nvl_mode.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="side_image.html" title="Side Images"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="nvl_mode.html" title="NVL-Mode Tutorial"
accesskey="P">previous</a> |</li>
<li> <img src="_static/logo.png" width=19 height=21 align=center>
<li> <a href="http://www.renpy.org/">Ren'Py Home</a> |
<li><a href="index.html">Ren'Py Documentation</a></li>
</ul>
</div>
<div class="container">
<div class="span4">
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="nvl_mode.html"
title="previous chapter">NVL-Mode Tutorial</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="side_image.html"
title="next chapter">Side Images</a></p>
<h4>Search</h4>
<div id="cse-search-form" style="width: 100%;"></div>
<div class="copydata">
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
<br>
</div>
</div>
</div>
</div>
<div class="document span20 last">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="text-input">
<h1>Text Input<a class="headerlink" href="#text-input" title="Permalink to this headline">¶</a></h1>
<p>With some limitations, Ren'Py can prompt the user to input a small
amount of text. This prompting is done by the renpy.input function,
which returns the entered text, allowing it to be saved in a variable
or otherwise processed.</p>
<p>Right now, text input is limited to languages that do not require
input method (IME) support. Most western languages should work, but
Chinese, Japanese, and Korean probably won't.</p>
<p>The renpy.input function is defined as:</p>
<dl class="function">
<dt id="renpy.input">
<tt class="descclassname">renpy.</tt><tt class="descname">input</tt><big>(</big><em>prompt</em>, <em>default=''</em>, <em>allow=None</em>, <em>exclude='{}'</em>, <em>length=None</em>, <em>with_none=None</em>, <em>pixel_width=None</em><big>)</big><a class="headerlink" href="#renpy.input" title="Permalink to this definition">¶</a></dt>
<dd><p>Calling this function pops up a window asking the player to enter some
text. It returns the entered text.</p>
<dl class="docutils">
<dt><cite>prompt</cite></dt>
<dd>A string giving a prompt to display to the player.</dd>
<dt><cite>default</cite></dt>
<dd>A string giving the initial text that will be edited by the player.</dd>
<dt><cite>allow</cite></dt>
<dd>If not None, a string giving a list of characters that will
be allowed in the text.</dd>
<dt><cite>exclude</cite></dt>
<dd>If not None, if a character is present in this string, it is not
allowed in the text.</dd>
<dt><cite>length</cite></dt>
<dd>If not None, this must be an integer giving the maximum length
of the input string.</dd>
<dt><cite>pixel_width</cite></dt>
<dd>If not None, the input is limited to being this many pixels wide,
in the font used by the input to display text.</dd>
</dl>
</dd></dl>
<p>Code that uses renpy.input will often want to process the result
further, using standard python string manipulation functions. For
example, the following code will ask the player for his or her
name and remove leading or trailing whitespace. If the name is
empty, it will be replaced by a default name. Finally, it is
displayed to the user.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">define</span> <span class="n">pov</span> <span class="o">=</span> <span class="n">Character</span><span class="p">(</span><span class="s">"[povname]"</span><span class="p">)</span>
<span class="k">python</span><span class="p">:</span>
<span class="n">povname</span> <span class="o">=</span> <span class="n">renpy</span><span class="o">.</span><span class="k">input</span><span class="p">(</span><span class="s">"What is your name?"</span><span class="p">)</span>
<span class="n">povname</span> <span class="o">=</span> <span class="n">povname</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="k">not</span> <span class="n">povname</span><span class="p">:</span>
<span class="n">povname</span> <span class="o">=</span> <span class="s">"Pat Smith"</span>
<span class="n">pov</span> <span class="s">"My name is [povname]!"</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="side_image.html" title="Side Images"
>next</a> |</li>
<li class="right" >
<a href="nvl_mode.html" title="NVL-Mode Tutorial"
>previous</a> |</li>
<li> <img src="_static/logo.png" width=19 height=21 align=center>
<li> <a href="http://www.renpy.org/">Ren'Py Home</a> |
<li><a href="index.html">Ren'Py Documentation</a></li>
</ul>
</div>
</body>
</html>
|