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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Developer Tools — 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="Statement Equivalents" href="statement_equivalents.html" />
<link rel="prev" title="Customizing the Keymap" href="keymap.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="statement_equivalents.html" title="Statement Equivalents"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="keymap.html" title="Customizing the Keymap"
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">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Developer Tools</a><ul>
<li><a class="reference internal" href="#shift-o-console">Shift+O Console</a></li>
<li><a class="reference internal" href="#shift-e-editor-support">Shift+E Editor Support</a></li>
<li><a class="reference internal" href="#shift-d-developer-menu">Shift+D Developer Menu</a></li>
<li><a class="reference internal" href="#shift-r-reloading">Shift+R Reloading</a></li>
<li><a class="reference internal" href="#shift-i-style-inspecting">Shift+I Style Inspecting</a></li>
<li><a class="reference internal" href="#shift-y-style-dumping">Shift+Y Style Dumping</a></li>
<li><a class="reference internal" href="#fast-skipping">> Fast Skipping</a></li>
<li><a class="reference internal" href="#warping-to-a-line">Warping to a Line</a></li>
<li><a class="reference internal" href="#debug-functions">Debug Functions</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="keymap.html"
title="previous chapter">Customizing the Keymap</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="statement_equivalents.html"
title="next chapter">Statement Equivalents</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="developer-tools">
<h1>Developer Tools<a class="headerlink" href="#developer-tools" title="Permalink to this headline">¶</a></h1>
<p>Ren'Py includes a number of features to make a developer's life easier. Many of
them need the variable <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> to be set to True to operate.</p>
<div class="section" id="shift-o-console">
<h2>Shift+O Console<a class="headerlink" href="#shift-o-console" title="Permalink to this headline">¶</a></h2>
<p>The debug console makes it possible to interactively run Ren'Py script and
Python statements, and immediately see the results. The console is available in
developer mode or when <tt class="xref std std-var docutils literal"><span class="pre">config.console</span></tt> is True, and can be accessed by
pressing "shift+O".</p>
<p>The console can be used to:</p>
<ul class="simple">
<li>Jump to a label.</li>
<li>Interactively try out Ren'Py script statements.</li>
<li>Evaluate a python expression or statement to see the result.</li>
<li>Trace python expressions as the game progresses.</li>
</ul>
</div>
<div class="section" id="shift-e-editor-support">
<h2>Shift+E Editor Support<a class="headerlink" href="#shift-e-editor-support" title="Permalink to this headline">¶</a></h2>
<p>The <tt class="xref std std-var docutils literal"><span class="pre">config.editor</span></tt> variable allows a developer to specify an editor
command that is run when the launch_editor keypress (by default, "shift-E")
occurs.</p>
<p>please see <a class="reference internal" href="editor.html#text-editor-integration"><em>Text Editor Integration</em></a></p>
</div>
<div class="section" id="shift-d-developer-menu">
<h2>Shift+D Developer Menu<a class="headerlink" href="#shift-d-developer-menu" title="Permalink to this headline">¶</a></h2>
<p>When <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> is true, hitting "shift+D" will display a developer
menu that provides easy access to some of the features given below.</p>
</div>
<div class="section" id="shift-r-reloading">
<h2>Shift+R Reloading<a class="headerlink" href="#shift-r-reloading" title="Permalink to this headline">¶</a></h2>
<p>When <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> is true, hitting "shift+R" will save the current
game, reload the game script, and reload the game. This will often place you at
the last unchanged statement encountered before "shift+R" was pressed.</p>
<p>This allows the developer to make script changes with an external editor, and
not have to exit and restart Ren'Py to see the effect of the changes.</p>
<p>Note that game state, which includes variable values and scene lists, is
preserved across the reload. This means that if one of those statements is
changed, it is necessary to rollback and re-execute the statement to see its
new effect.</p>
</div>
<div class="section" id="shift-i-style-inspecting">
<h2>Shift+I Style Inspecting<a class="headerlink" href="#shift-i-style-inspecting" title="Permalink to this headline">¶</a></h2>
<p>When <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> is true, pressing "shift+I" will cause style
inspection to occur. This will display a list of displayables underneath the
mouse. For each displayable, it will display the type, the style used, and the
size it is being rendered at.</p>
</div>
<div class="section" id="shift-y-style-dumping">
<h2>Shift+Y Style Dumping<a class="headerlink" href="#shift-y-style-dumping" title="Permalink to this headline">¶</a></h2>
<p>When <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> is True, pressing the dump_styles key (by default,
"shift-Y"), will write a description of every style Ren'Py knows about to the
file "styles.txt". This description includes every property that is part of the
style, the value of that property, and the style the property is inherited
from.</p>
</div>
<div class="section" id="fast-skipping">
<h2>> Fast Skipping<a class="headerlink" href="#fast-skipping" title="Permalink to this headline">¶</a></h2>
<p>When <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> or <tt class="xref std std-var docutils literal"><span class="pre">config.fast_skipping`</span></tt> is True, pressing
the fast_skip key (by default, ">") causes the the game to immediately skip to
the next important interaction. For this purpose, an important interaction is
one that is not caused by a say statement, transition, or pause command.
Usually, this means skipping to the next menu, but it will also stop when
user-defined forms of interaction occur.</p>
</div>
<div class="section" id="warping-to-a-line">
<span id="id1"></span><h2>Warping to a Line<a class="headerlink" href="#warping-to-a-line" title="Permalink to this headline">¶</a></h2>
<p>Ren'Py supports warping to a line in the script, without the developer to play
through the entire game to get there. While this warping technique has a number
of warnings associated with it, it still may be useful in providing a live
preview.</p>
<p>To invoke warping, run Ren'Py with the <tt class="docutils literal"><span class="pre">--warp</span></tt> command-line argument followed
by a filename:line combination, to specify where you would like to warp to. For
example</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="n">renpy</span><span class="o">.</span><span class="n">exe</span> <span class="n">my_project</span> <span class="o">--</span><span class="n">warp</span> <span class="n">script</span><span class="o">.</span><span class="n">rpy</span><span class="p">:</span><span class="mi">458</span>
</pre></div>
</div>
<p>(Where <cite>my_project</cite> is the full path to the base directory of your project.)</p>
<p>When warping is invoked, Ren'Py does a number of things. It first finds all of
the scene statements in the program. It then tries to find a path from the
scene statements to every reachable statement in the game. It then picks the
reachable statement closest to, but before or at, the given line. It works
backwards from that statement to a scene statement, recording the path it took.
Ren'Py then executes the scene statement and any show or hide statements found
along that path. Finally, it transfers control to the found statement.</p>
<p>There are a number of fairly major caveats to the warp feature. The first is
that it only examines a single path, which means that while the path may be
representative of some route of execution, it's possible that there may be a
bug along some other route. In general, the path doesn't consider game logic,
so it's also possible to have a path that isn't actually reachable. (This is
only really a problem on control-heavy games, espcially those that use a lot of
python code.</p>
<p>The biggest problem, though, is that no python code is executed before the
statement that is warped to. This means that all variables will be
uninitalized, which can lead to crashes when they are used. To overcome this,
one can define a label <tt class="docutils literal"><span class="pre">after_warp</span></tt>, which is called after a warp but before
the warped-to statement executes. The code reached by this label can set up
variables in the program, and then return to the preview.</p>
<p>The warp feature requires <a class="reference internal" href="config.html#var-config.developer"><tt class="xref std std-var docutils literal"><span class="pre">config.developer</span></tt></a> to be True to operate.</p>
</div>
<div class="section" id="debug-functions">
<h2>Debug Functions<a class="headerlink" href="#debug-functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="renpy.get_filename_line">
<tt class="descclassname">renpy.</tt><tt class="descname">get_filename_line</tt><big>(</big><big>)</big><a class="headerlink" href="#renpy.get_filename_line" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a pair giving the filename and line number of the current
statement.</p>
</dd></dl>
<dl class="function">
<dt id="renpy.log">
<tt class="descclassname">renpy.</tt><tt class="descname">log</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#renpy.log" title="Permalink to this definition">¶</a></dt>
<dd><p>If <a class="reference internal" href="config.html#var-config.log"><tt class="xref std std-var docutils literal"><span class="pre">config.log</span></tt></a> is not set, this does nothing. Otherwise, it opens
the logfile (if not already open), formats the message to 70
columns, and prints it to the logfile.</p>
</dd></dl>
<dl class="function">
<dt id="renpy.watch">
<tt class="descclassname">renpy.</tt><tt class="descname">watch</tt><big>(</big><em>expression</em>, <em>style='default'</em>, <em>**properties</em><big>)</big><a class="headerlink" href="#renpy.watch" title="Permalink to this definition">¶</a></dt>
<dd><p>This watches the given python expression, by displaying it in the
upper-left corner of the screen (although position properties
can change that). The expression should always be
defined, never throwing an exception.</p>
<p>A watch will not persist through a save or restart.</p>
</dd></dl>
</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="statement_equivalents.html" title="Statement Equivalents"
>next</a> |</li>
<li class="right" >
<a href="keymap.html" title="Customizing the Keymap"
>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>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en' });
google.setOnLoadCallback(function() {
var customSearchControl = new google.search.CustomSearchControl('012476843541036121001:gx3sqkoaxkm');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
var options = new google.search.DrawOptions();
options.enableSearchboxOnly("http://www.google.com/cse?cx=012476843541036121001:gx3sqkoaxkm");
customSearchControl.draw('cse-search-form', options);
}, true);
</script>
</body>
</html>
|
