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
|
<html><head><title>renpy.input - Ren'Py Visual Novel Engine</title><link href="../../shared.css" rel="stylesheet"><link href="../../monobook.css" rel="stylesheet"><link href="../../common.css" rel="stylesheet"><link href="../../monobook2.css" rel="stylesheet"><link href="../../docs.css" rel="stylesheet" /></link></link></link></link></head><body><div id="bodyContent">
<p class="docnav"><a href="../../index.html">documentation index</a> ◦ <a href="../Reference_Manual.html">reference manual</a> ◦ <a href="../Function_Index.html">function index</a></p><p><a id="renpy.input" name="renpy.input"></a></p>
<h1><span class="mw-headline">renpy.input</span></h1>
<p><span id="renpy.input" /></p>
<table>
<tr>
<td valign="top">Function:</td>
<td valign="top"><b><strong class="selflink">renpy.input</strong></b></td>
<td valign="top">(prompt, default=<i>, allow=None, exclude='{}', length=None, with_none=None):</i></td>
</tr>
</table>
<div class="renpy-doc">
<p>This pops up a window requesting that the user enter in some text. It returns the entered text.</p>
<p><i>prompt</i> - A prompt that is used to ask the user for the text.</p>
<p><i>default</i> - A default for the text that this input can return.</p>
<p><i>length</i> - If given, a limit to the amount of text that this function will return.</p>
<p><i>allow</i> - If not None, then if an input character is not in this string, it is ignored.</p>
<p><i>exclude</i> - If not None, then if an input character is in this set, it is ignored.</p>
<p><i>with_none</i> - If True, causes a "with None" statement to be run after each interaction. If None (the default), checks config.implicit_with_none to determine if a "with None" should be run.</p>
</div>
<p><a id="Example" name="Example"></a></p>
<h2><span class="mw-headline">Example</span></h2>
<pre>
$ name <span class="sym">=</span> renpy<span class="sym">.</span><span class="kwb">input</span><span class="sym">(</span><span class="str">"What is your name?"</span><span class="sym">,</span> <span class="str">"Joe User"</span><span class="sym">,</span> length<span class="sym">=</span><span class="num">20</span><span class="sym">)</span>
e <span class="str">"Pleased to meet you, %(name)s."</span>
</pre>
<p><br /></p>
<div class="visualClear" />
<hr /><p class="docnav"><a href="../../index.html">documentation index</a> ◦ <a href="../Reference_Manual.html">reference manual</a> ◦ <a href="../Function_Index.html">function index</a></p></div>
</body></html>
|
