File: Text.html

package info (click to toggle)
renpy 6.10.2.dfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 19,468 kB
  • ctags: 5,383
  • sloc: python: 17,801; ansic: 7,116; makefile: 127; sh: 15
file content (37 lines) | stat: -rw-r--r-- 2,422 bytes parent folder | download
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
<html><head><title>Text - 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> &#9702; <a href="../Reference_Manual.html">reference manual</a> &#9702; <a href="../Function_Index.html">function index</a></p><p><a id="Text" name="Text"></a></p>
<h1><span class="mw-headline">Text</span></h1>
<p><span id="Text" /></p>
<table>
<tr>
<td valign="top">Function:</td>
<td valign="top"><b><strong class="selflink">Text</strong></b></td>
<td valign="top">(text, slow=False, slow_done=None, slow_speed=None, slow_start=0, slow_abortable=False, pause=None, tokenized=False, style='default', **properties):</td>
</tr>
</table>
<div class="renpy-doc">
<p>A displayable that can format and display text on the screen.</p>
<p><i>text</i> - The text that will be displayed on the screen.</p>
<p><i>slow</i> - If True, the text will be typed at the screen at a rate determined by the slow_cps property, if set, or the "Text Speed" preference. If None (the default), then it will be typed at a speed determined by the slow_cps property. If False, then it will appear instantly.</p>
<p><i>style</i> - A style that will be applied to the text.</p>
<p><i>properties</i> - Additional properties that are applied to the text.</p>
<p><i>pause</i> - If not None, then we display up to the pauseth pause (0-numbered.)</p>
<p><i>slow_done</i> - A callback that occurs when slow text is done.</p>
<p><i>slow_speed</i> - The speed of slow text. If none, it's taken from the preferences.</p>
<p><i>slow_offset</i> - The offset into the text to start the slow text.</p>
<p><i>slow_abortable</i> - If True, clicking aborts the slow text.</p>
<p><i>tokenized</i> - True if the text is already tokenized.</p>
</div>
<p><a id="Example" name="Example"></a></p>
<h2><span class="mw-headline">Example</span></h2>
<pre>
TODO
</pre>
<p><br /></p>




<div class="visualClear" />
		<hr /><p class="docnav"><a href="../../index.html">documentation index</a> &#9702; <a href="../Reference_Manual.html">reference manual</a> &#9702; <a href="../Function_Index.html">function index</a></p></div>
	</body></html>