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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Special Screen Names — 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="Configuration Variables" href="config.html" />
<link rel="prev" title="Screen Actions, Values, and Functions" href="screen_actions.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="config.html" title="Configuration Variables"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="screen_actions.html" title="Screen Actions, Values, and Functions"
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="#">Special Screen Names</a><ul>
<li><a class="reference internal" href="#in-game-screens">In-Game Screens</a><ul>
<li><a class="reference internal" href="#say">Say</a></li>
<li><a class="reference internal" href="#choice">Choice</a></li>
<li><a class="reference internal" href="#input">Input</a></li>
<li><a class="reference internal" href="#nvl">NVL</a></li>
<li><a class="reference internal" href="#notify">Notify</a></li>
</ul>
</li>
<li><a class="reference internal" href="#menu-screens">Menu Screens</a><ul>
<li><a class="reference internal" href="#main-menu">Main Menu</a></li>
<li><a class="reference internal" href="#navigation">Navigation</a></li>
<li><a class="reference internal" href="#save">Save</a></li>
<li><a class="reference internal" href="#load">Load</a></li>
<li><a class="reference internal" href="#preferences">Preferences</a></li>
<li><a class="reference internal" href="#yesno-prompt">Yesno_Prompt</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="screen_actions.html"
title="previous chapter">Screen Actions, Values, and Functions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="config.html"
title="next chapter">Configuration Variables</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="special-screen-names">
<h1>Special Screen Names<a class="headerlink" href="#special-screen-names" title="Permalink to this headline">¶</a></h1>
<p>There are two kinds of special screen names in Ren'Py. The first are
screens that will be automatically displayed when Ren'Py script
language commands (or their programmatic equivalents) are run. The
other type are menu screens. These have conventional names for
conventional functionality, but screens can be omitted or changed as
is deemed necessary.</p>
<p>On this page, we'll give example screens. It's important to realize
that, while some screens must have minimal functionality, the screen
system makes it possible to add additional functionality to
screens. For example, while the standard say screen only displays
text, the screen systen makes it easy to add features like skipping,
auto-forward mode, or muting.</p>
<p>Some special screens take parameters. These parameters can be accessed
as variables in the screen's scope.</p>
<p>Some of the screens also have special ids associated with them. A
special id should be assigned to a displayable of a given type. It can
cause properties to be assigned to that displayable, and can make that
displayable accessible to calling code.</p>
<div class="section" id="in-game-screens">
<h2>In-Game Screens<a class="headerlink" href="#in-game-screens" title="Permalink to this headline">¶</a></h2>
<p>These screens are automatically displayed when certain Ren'Py
statements execute.</p>
<div class="section" id="say">
<span id="say-screen"></span><h3>Say<a class="headerlink" href="#say" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">say</span></tt> screen is called by the say statement, when displaying
ADV-mode dialogue. It is displayed with the following parameters:</p>
<dl class="docutils">
<dt><cite>who</cite></dt>
<dd>The text of the name of the speaking character.</dd>
<dt><cite>what</cite></dt>
<dd>The dialogue being said by the speaking character.</dd>
</dl>
<p>It's expected to declare displayables with the following ids:</p>
<dl class="docutils">
<dt>"who"</dt>
<dd>A text displayable, displaying the name of the speaking
character. The character object can be given arguments that style
this displayable.</dd>
<dt>"what"</dt>
<dd>A text displayable, displaying the dialogue being said by the
speaking character. The character object can be given arguments that style
this displayable. <strong>A displayable with this id must be defined</strong>,
as Ren'Py uses it to calculate auto-forward-mode time,
click-to-continue, and other things.</dd>
<dt>"window"</dt>
<dd>A window or frame. This conventionally contains the who and what
text. The character object can be given arguments that style
this displayable.</dd>
</dl>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">say</span><span class="p">:</span>
<span class="k">window</span> <span class="na">id</span> <span class="s">"window"</span><span class="p">:</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">if</span> <span class="n">who</span><span class="p">:</span>
<span class="k">text</span> <span class="n">who</span> <span class="na">id</span> <span class="s">"who"</span>
<span class="k">text</span> <span class="n">what</span> <span class="na">id</span> <span class="s">"what"</span>
</pre></div>
</div>
</div>
<div class="section" id="choice">
<span id="choice-screen"></span><h3>Choice<a class="headerlink" href="#choice" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">choice</span></tt> screen is used to display the in-game choices created
with the menu statement. It is given the following parameter:</p>
<dl class="docutils">
<dt><cite>items</cite></dt>
<dd>This is a list of (<cite>caption</cite>, <cite>action</cite>, <cite>chosen</cite>)
tuples. For each choice, <cite>caption</cite> is the name of the choice, and
<cite>action</cite> is the action to invoke for the choice, or None if this
is a choice label. <cite>Chosen</cite> if a choice with this label has been
chosen by the user before. (It doesn't have to be in the current
game.)</dd>
</dl>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="k">choice</span><span class="p">:</span>
<span class="k">window</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"menu_window"</span>
<span class="k">vbox</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"menu"</span>
<span class="k">for</span> <span class="n">caption</span><span class="p">,</span> <span class="na">action</span><span class="p">,</span> <span class="n">chosen</span> <span class="k">in</span> <span class="n">items</span><span class="p">:</span>
<span class="k">if</span> <span class="na">action</span><span class="p">:</span>
<span class="k">button</span><span class="p">:</span>
<span class="na">action</span> <span class="na">action</span>
<span class="k">style</span> <span class="s">"menu_choice_button"</span>
<span class="k">text</span> <span class="n">caption</span> <span class="k">style</span> <span class="s">"menu_choice"</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">text</span> <span class="n">caption</span> <span class="k">style</span> <span class="s">"menu_caption"</span>
</pre></div>
</div>
</div>
<div class="section" id="input">
<span id="input-screen"></span><h3>Input<a class="headerlink" href="#input" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">input</span></tt> screen is used to display <a class="reference internal" href="input.html#renpy.input" title="renpy.input"><tt class="xref py py-func docutils literal"><span class="pre">renpy.input()</span></tt></a>. It is given one
parameter:</p>
<dl class="docutils">
<dt><cite>prompt</cite></dt>
<dd>The prompt text supplied to renpy.input.</dd>
</dl>
<p>It is expected to declare a displayable with the following id:</p>
<dl class="docutils">
<dt>"input"</dt>
<dd>An input displayable, which must exist. This is given all the
parameters supplied to renpy.input, so it must exist.</dd>
</dl>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="nb">input</span><span class="p">:</span>
<span class="k">window</span><span class="p">:</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">text</span> <span class="n">prompt</span>
<span class="nb">input</span> <span class="na">id</span> <span class="s">"input"</span>
</pre></div>
</div>
</div>
<div class="section" id="nvl">
<span id="nvl-screen"></span><h3>NVL<a class="headerlink" href="#nvl" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">nvl</span></tt> screen is used to display NVL-mode dialogue. It is given
the following parameter:</p>
<dl class="docutils">
<dt><cite>dialogue</cite></dt>
<dd>This is a list of ( <cite>who</cite>, <cite>what</cite>, <cite>who_id</cite>, <cite>what_id</cite>,
<cite>window_id</cite>) tuples, each of which corresponds to a line of
dialogue on the screen. <cite>Who</cite> and <cite>what</cite> are strings containing
the speaking character and the line of dialogue, respectively. The
ids should be assigned to the who and what text displayables, and
a window containing each unit of dialogue.</dd>
<dt><cite>items</cite></dt>
<dd><p class="first">This is a list of (<cite>caption</cite>, <cite>action</cite>, <cite>chosen</cite>)
tuples. For each choice, <cite>caption</cite> is the name of the choice, and
<cite>action</cite> is the action to invoke for the choice, or None if this
is a choice label. <cite>Chosen</cite> if a choice with this label has been
chosen by the user before. (It doesn't have to be in the current
game.)</p>
<p class="last">If items is empty, the menu should not be shown.</p>
</dd>
</dl>
<p>Ren'Py also supports an <tt class="docutils literal"><span class="pre">nvl_choice</span></tt> screen, which takes the same
parameters as <tt class="docutils literal"><span class="pre">nvl</span></tt>, and is used in preference to <tt class="docutils literal"><span class="pre">nvl</span></tt> when
an in-game choice is presented to the user, if it exists.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="k">nvl</span><span class="p">:</span>
<span class="k">window</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"nvl_window"</span>
<span class="k">has</span> <span class="k">vbox</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"nvl_vbox"</span>
<span class="c"># Display dialogue.</span>
<span class="k">for</span> <span class="n">who</span><span class="p">,</span> <span class="n">what</span><span class="p">,</span> <span class="n">who_id</span><span class="p">,</span> <span class="n">what_id</span><span class="p">,</span> <span class="n">window_id</span> <span class="k">in</span> <span class="n">dialogue</span><span class="p">:</span>
<span class="k">window</span><span class="p">:</span>
<span class="na">id</span> <span class="n">window_id</span>
<span class="k">has</span> <span class="k">hbox</span><span class="p">:</span>
<span class="na">spacing</span> <span class="mi">10</span>
<span class="k">if</span> <span class="n">who</span> <span class="k">is</span> <span class="k">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">text</span> <span class="n">who</span> <span class="na">id</span> <span class="n">who_id</span>
<span class="k">text</span> <span class="n">what</span> <span class="na">id</span> <span class="n">what_id</span>
<span class="c"># Display a menu, if given.</span>
<span class="k">if</span> <span class="n">items</span><span class="p">:</span>
<span class="k">vbox</span><span class="p">:</span>
<span class="na">id</span> <span class="s">"menu"</span>
<span class="k">for</span> <span class="n">caption</span><span class="p">,</span> <span class="na">action</span><span class="p">,</span> <span class="n">chosen</span> <span class="k">in</span> <span class="n">items</span><span class="p">:</span>
<span class="k">if</span> <span class="na">action</span><span class="p">:</span>
<span class="k">button</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"nvl_menu_choice_button"</span>
<span class="na">action</span> <span class="na">action</span>
<span class="k">text</span> <span class="n">caption</span> <span class="k">style</span> <span class="s">"nvl_menu_choice"</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">text</span> <span class="n">caption</span> <span class="k">style</span> <span class="s">"nvl_dialogue"</span>
</pre></div>
</div>
</div>
<div class="section" id="notify">
<span id="notify-screen"></span><h3>Notify<a class="headerlink" href="#notify" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">notify</span></tt> screen is used by <a class="reference internal" href="other.html#renpy.notify" title="renpy.notify"><tt class="xref py py-func docutils literal"><span class="pre">renpy.notify()</span></tt></a> to display
notifications to the user. It's generally used in conjunction with a
transform to handle the entire task of notification. It's given a
single parameter:</p>
<dl class="docutils">
<dt><cite>message</cite></dt>
<dd>The message to display.</dd>
</dl>
<p>The default notify screen, and its associated transform, are:</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">notify</span><span class="p">:</span>
<span class="k">zorder</span> <span class="mi">100</span>
<span class="k">text</span> <span class="n">message</span> <span class="k">at</span> <span class="n">_notify_transform</span>
<span class="c"># This controls how long it takes between when the screen is</span>
<span class="c"># first shown, and when it begins hiding.</span>
<span class="k">timer</span> <span class="mf">3.25</span> <span class="na">action</span> <span class="n">Hide</span><span class="p">(</span><span class="s">'notify'</span><span class="p">)</span>
<span class="k">transform</span> <span class="n">_notify_transform</span><span class="p">:</span>
<span class="c"># These control the position.</span>
<span class="na">xalign</span> <span class="o">.</span><span class="mo">02</span> <span class="na">yalign</span> <span class="o">.</span><span class="mo">015</span>
<span class="c"># These control the actions on show and hide.</span>
<span class="k">on</span> <span class="k">show</span><span class="p">:</span>
<span class="na">alpha</span> <span class="mi">0</span>
<span class="n">linear</span> <span class="o">.</span><span class="mi">25</span> <span class="na">alpha</span> <span class="mf">1.0</span>
<span class="k">on</span> <span class="k">hide</span><span class="p">:</span>
<span class="n">linear</span> <span class="o">.</span><span class="mi">5</span> <span class="na">alpha</span> <span class="mf">0.0</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="menu-screens">
<h2>Menu Screens<a class="headerlink" href="#menu-screens" title="Permalink to this headline">¶</a></h2>
<p>These are the menu screens. The <tt class="docutils literal"><span class="pre">main_menu</span></tt> and <tt class="docutils literal"><span class="pre">yesno_prompt</span></tt> are
invoked implictly. When the user invokes the game menu, the screen
named in <tt class="xref py py-data docutils literal"><span class="pre">_game_menu_screen</span></tt> will be displayed. (This defaults
to <tt class="docutils literal"><span class="pre">save</span></tt>.)</p>
<p>Remember, menu screens can be combined and modified fairly freely.</p>
<div class="section" id="main-menu">
<span id="main-menu-screen"></span><h3>Main Menu<a class="headerlink" href="#main-menu" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">main_menu</span></tt> screen is the first screen shown when the game
begins.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">main_menu</span><span class="p">:</span>
<span class="c"># This ensures that any other menu screen is replaced.</span>
<span class="n">tag</span> <span class="k">menu</span>
<span class="c"># The background of the main menu.</span>
<span class="k">window</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"mm_root"</span>
<span class="c"># The main menu buttons.</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"mm"</span>
<span class="na">xalign</span> <span class="o">.</span><span class="mi">98</span>
<span class="na">yalign</span> <span class="o">.</span><span class="mi">98</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Start Game"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Start</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Load Game"</span><span class="p">)</span> <span class="na">action</span> <span class="n">ShowMenu</span><span class="p">(</span><span class="s">"load"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Preferences"</span><span class="p">)</span> <span class="na">action</span> <span class="n">ShowMenu</span><span class="p">(</span><span class="s">"preferences"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Help"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Help</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Quit"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Quit</span><span class="p">(</span><span class="n">confirm</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="k">init</span> <span class="k">python</span><span class="p">:</span>
<span class="c"># Make all the main menu buttons be the same size.</span>
<span class="k">style</span><span class="o">.</span><span class="n">mm_button</span><span class="o">.</span><span class="na">size_group</span> <span class="o">=</span> <span class="s">"mm"</span>
</pre></div>
</div>
</div>
<div class="section" id="navigation">
<span id="navigation-screen"></span><h3>Navigation<a class="headerlink" href="#navigation" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">navigation</span></tt> screen isn't special to Ren'Py. But by convention,
we place the game menu navigation in a screen named <tt class="docutils literal"><span class="pre">navigation</span></tt>, and
then use that screen from the save, load and preferences screens.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">navigation</span><span class="p">:</span>
<span class="c"># The background of the game menu.</span>
<span class="k">window</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"gm_root"</span>
<span class="c"># The various buttons.</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"gm_nav"</span>
<span class="na">xalign</span> <span class="o">.</span><span class="mi">98</span>
<span class="na">yalign</span> <span class="o">.</span><span class="mi">98</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Return"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Return</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Preferences"</span><span class="p">)</span> <span class="na">action</span> <span class="n">ShowMenu</span><span class="p">(</span><span class="s">"preferences"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Save Game"</span><span class="p">)</span> <span class="na">action</span> <span class="n">ShowMenu</span><span class="p">(</span><span class="s">"save"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Load Game"</span><span class="p">)</span> <span class="na">action</span> <span class="n">ShowMenu</span><span class="p">(</span><span class="s">"load"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Main Menu"</span><span class="p">)</span> <span class="na">action</span> <span class="n">MainMenu</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Help"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Help</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Quit"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Quit</span><span class="p">()</span>
<span class="k">init</span> <span class="k">python</span><span class="p">:</span>
<span class="k">style</span><span class="o">.</span><span class="n">gm_nav_button</span><span class="o">.</span><span class="na">size_group</span> <span class="o">=</span> <span class="s">"gm_nav"</span>
</pre></div>
</div>
</div>
<div class="section" id="save">
<span id="save-screen"></span><h3>Save<a class="headerlink" href="#save" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">save</span></tt> screen is used to select a file in which to save the
game.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">save</span><span class="p">:</span>
<span class="c"># This ensures that any other menu screen is replaced.</span>
<span class="n">tag</span> <span class="k">menu</span>
<span class="k">use</span> <span class="n">navigation</span>
<span class="k">frame</span><span class="p">:</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="c"># The buttons at the top allow the user to pick a</span>
<span class="c"># page of files.</span>
<span class="k">hbox</span><span class="p">:</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Previous"</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePagePrevious</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Auto"</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePage</span><span class="p">(</span><span class="s">"auto"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="k">in</span> <span class="na">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">9</span><span class="p">):</span>
<span class="k">textbutton</span> <span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePage</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Next"</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePageNext</span><span class="p">()</span>
<span class="c"># Display a grid of file slots.</span>
<span class="k">grid</span> <span class="mi">2</span> <span class="mi">5</span><span class="p">:</span>
<span class="na">transpose</span> <span class="bp">True</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="c"># Display ten file slots, numbered 1 - 10.</span>
<span class="k">for</span> <span class="n">i</span> <span class="k">in</span> <span class="na">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">11</span><span class="p">):</span>
<span class="c"># Each file slot is a button.</span>
<span class="k">button</span><span class="p">:</span>
<span class="na">action</span> <span class="n">FileAction</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="k">style</span> <span class="s">"large_button"</span>
<span class="k">has</span> <span class="k">hbox</span>
<span class="c"># Add the screenshot and the description to the</span>
<span class="c"># button.</span>
<span class="k">add</span> <span class="n">FileScreenshot</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">text</span> <span class="p">(</span> <span class="s">" </span><span class="si">%2d</span><span class="s">. "</span> <span class="o">%</span> <span class="n">i</span>
<span class="o">+</span> <span class="n">FileTime</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">empty</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s">"Empty Slot."</span><span class="p">))</span>
<span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span>
<span class="o">+</span> <span class="n">FileSaveName</span><span class="p">(</span><span class="n">i</span><span class="p">))</span> <span class="k">style</span> <span class="s">"large_button_text"</span>
</pre></div>
</div>
</div>
<div class="section" id="load">
<span id="load-screen"></span><h3>Load<a class="headerlink" href="#load" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">load</span></tt> screen is used to select a file from which to load the
game.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">load</span><span class="p">:</span>
<span class="c"># This ensures that any other menu screen is replaced.</span>
<span class="n">tag</span> <span class="k">menu</span>
<span class="k">use</span> <span class="n">navigation</span>
<span class="k">frame</span><span class="p">:</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="c"># The buttons at the top allow the user to pick a</span>
<span class="c"># page of files.</span>
<span class="k">hbox</span><span class="p">:</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Previous"</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePagePrevious</span><span class="p">()</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Auto"</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePage</span><span class="p">(</span><span class="s">"auto"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="k">in</span> <span class="na">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">9</span><span class="p">):</span>
<span class="k">textbutton</span> <span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePage</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Next"</span><span class="p">)</span> <span class="na">action</span> <span class="n">FilePageNext</span><span class="p">()</span>
<span class="c"># Display a grid of file slots.</span>
<span class="k">grid</span> <span class="mi">2</span> <span class="mi">5</span><span class="p">:</span>
<span class="na">transpose</span> <span class="bp">True</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="c"># Display ten file slots, numbered 1 - 10.</span>
<span class="k">for</span> <span class="n">i</span> <span class="k">in</span> <span class="na">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">11</span><span class="p">):</span>
<span class="c"># Each file slot is a button.</span>
<span class="k">button</span><span class="p">:</span>
<span class="na">action</span> <span class="n">FileAction</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="k">style</span> <span class="s">"large_button"</span>
<span class="k">has</span> <span class="k">hbox</span>
<span class="c"># Add the screenshot and the description to the</span>
<span class="c"># button.</span>
<span class="k">add</span> <span class="n">FileScreenshot</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
<span class="k">text</span> <span class="p">(</span> <span class="s">" </span><span class="si">%2d</span><span class="s">. "</span> <span class="o">%</span> <span class="n">i</span>
<span class="o">+</span> <span class="n">FileTime</span><span class="p">(</span><span class="n">i</span><span class="p">,</span> <span class="n">empty</span><span class="o">=</span><span class="n">_</span><span class="p">(</span><span class="s">"Empty Slot."</span><span class="p">))</span>
<span class="o">+</span> <span class="s">"</span><span class="se">\n</span><span class="s">"</span>
<span class="o">+</span> <span class="n">FileSaveName</span><span class="p">(</span><span class="n">i</span><span class="p">))</span> <span class="k">style</span> <span class="s">"large_button_text"</span>
</pre></div>
</div>
</div>
<div class="section" id="preferences">
<span id="preferences-screen"></span><h3>Preferences<a class="headerlink" href="#preferences" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">preferences</span></tt> screen is used to select options that control the
display of the game.</p>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">preferences</span><span class="p">:</span>
<span class="n">tag</span> <span class="k">menu</span>
<span class="c"># Include the navigation.</span>
<span class="k">use</span> <span class="n">navigation</span>
<span class="c"># Put the navigation columns in a three-wide grid.</span>
<span class="k">grid</span> <span class="mi">3</span> <span class="mi">1</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"prefs"</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="c"># The left column.</span>
<span class="k">vbox</span><span class="p">:</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Display"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Window"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"display"</span><span class="p">,</span> <span class="s">"window"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Fullscreen"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"display"</span><span class="p">,</span> <span class="s">"fullscreen"</span><span class="p">)</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Transitions"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"All"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"transitions"</span><span class="p">,</span> <span class="s">"all"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"None"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"transitions"</span><span class="p">,</span> <span class="s">"none"</span><span class="p">)</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Text Speed"</span><span class="p">)</span>
<span class="k">bar</span> <span class="na">value</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"text speed"</span><span class="p">)</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Joystick..."</span><span class="p">)</span> <span class="na">action</span> <span class="n">ShowMenu</span><span class="p">(</span><span class="s">"joystick_preferences"</span><span class="p">)</span>
<span class="k">vbox</span><span class="p">:</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Skip"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Seen Messages"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"skip"</span><span class="p">,</span> <span class="s">"seen"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"All Messages"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"skip"</span><span class="p">,</span> <span class="s">"all"</span><span class="p">)</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Begin Skipping"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Skip</span><span class="p">()</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"After Choices"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Stop Skipping"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"after choices"</span><span class="p">,</span> <span class="s">"stop"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Keep Skipping"</span><span class="p">)</span> <span class="na">action</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"after choices"</span><span class="p">,</span> <span class="s">"skip"</span><span class="p">)</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Auto-Forward Time"</span><span class="p">)</span>
<span class="k">bar</span> <span class="na">value</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"auto-forward time"</span><span class="p">)</span>
<span class="k">vbox</span><span class="p">:</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Music Volume"</span><span class="p">)</span>
<span class="k">bar</span> <span class="na">value</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"music volume"</span><span class="p">)</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Sound Volume"</span><span class="p">)</span>
<span class="k">bar</span> <span class="na">value</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"sound volume"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="s">"Test"</span> <span class="na">action</span> <span class="n">Play</span><span class="p">(</span><span class="s">"sound"</span><span class="p">,</span> <span class="s">"sound_test.ogg"</span><span class="p">)</span> <span class="k">style</span> <span class="s">"soundtest_button"</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"pref"</span>
<span class="k">has</span> <span class="k">vbox</span>
<span class="k">label</span> <span class="n">_</span><span class="p">(</span><span class="s">"Voice Volume"</span><span class="p">)</span>
<span class="k">bar</span> <span class="na">value</span> <span class="n">Preference</span><span class="p">(</span><span class="s">"voice volume"</span><span class="p">)</span>
<span class="k">textbutton</span> <span class="s">"Test"</span> <span class="na">action</span> <span class="n">Play</span><span class="p">(</span><span class="s">"voice"</span><span class="p">,</span> <span class="s">"voice_test.ogg"</span><span class="p">)</span> <span class="k">style</span> <span class="s">"soundtest_button"</span>
<span class="k">init</span> <span class="k">python</span><span class="p">:</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_frame</span><span class="o">.</span><span class="na">xfill</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_frame</span><span class="o">.</span><span class="na">xmargin</span> <span class="o">=</span> <span class="mi">5</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_frame</span><span class="o">.</span><span class="na">top_margin</span> <span class="o">=</span> <span class="mi">5</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_vbox</span><span class="o">.</span><span class="na">xfill</span> <span class="o">=</span> <span class="bp">True</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_button</span><span class="o">.</span><span class="na">size_group</span> <span class="o">=</span> <span class="s">"pref"</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_button</span><span class="o">.</span><span class="na">xalign</span> <span class="o">=</span> <span class="mf">1.0</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_slider</span><span class="o">.</span><span class="na">xmaximum</span> <span class="o">=</span> <span class="mi">192</span>
<span class="k">style</span><span class="o">.</span><span class="n">pref_slider</span><span class="o">.</span><span class="na">xalign</span> <span class="o">=</span> <span class="mf">1.0</span>
<span class="k">style</span><span class="o">.</span><span class="n">soundtest_button</span><span class="o">.</span><span class="na">xalign</span> <span class="o">=</span> <span class="mf">1.0</span>
</pre></div>
</div>
</div>
<div class="section" id="yesno-prompt">
<span id="yesno-prompt-screen"></span><h3>Yesno_Prompt<a class="headerlink" href="#yesno-prompt" title="Permalink to this headline">¶</a></h3>
<p>The <tt class="docutils literal"><span class="pre">yesno_prompt</span></tt> message is used to ask yes/no choices of the
user. It takes the following parameters:</p>
<dl class="docutils">
<dt><cite>message</cite></dt>
<dd><p class="first">The message to display to the user. This is one of:</p>
<ul class="simple">
<li>layout.ARE_YOU_SURE - "Are you sure?" This should be
the default if the message is unknown.</li>
<li>layout.DELETE_SAVE - "Are you sure you want to delete this save?"</li>
<li>layout.OVERWRITE_SAVE - "Are you sure you want to overwrite your save?"</li>
<li>layout.LOADING - "Loading will lose unsaved progress.nAre you sure you want to do this?"</li>
<li>layout.QUIT - "Are you sure you want to quit?"</li>
<li>layout.MAIN_MENU - "Are you sure you want to return to the mainnmenu? This will lose unsaved progress."</li>
</ul>
<p class="last">The values of the variables are strings, which means they can be
displayed using a text displayable.</p>
</dd>
<dt><cite>yes_action</cite></dt>
<dd>The action to run when the user picks "Yes".</dd>
<dt><cite>no_action</cite></dt>
<dd>The action to run when the user picks "No".</dd>
</dl>
<div class="highlight-renpy"><div class="highlight"><pre><span class="k">screen</span> <span class="n">yesno_prompt</span><span class="p">:</span>
<span class="n">modal</span> <span class="bp">True</span>
<span class="k">window</span><span class="p">:</span>
<span class="k">style</span> <span class="s">"gm_root"</span>
<span class="k">frame</span><span class="p">:</span>
<span class="na">style_group</span> <span class="s">"yesno_prompt"</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="na">xmargin</span> <span class="mi">50</span>
<span class="na">ypadding</span> <span class="mi">25</span>
<span class="na">yalign</span> <span class="o">.</span><span class="mi">25</span>
<span class="k">vbox</span><span class="p">:</span>
<span class="na">xfill</span> <span class="bp">True</span>
<span class="na">spacing</span> <span class="mi">25</span>
<span class="k">text</span> <span class="n">_</span><span class="p">(</span><span class="n">message</span><span class="p">):</span>
<span class="na">text_align</span> <span class="mf">0.5</span>
<span class="na">xalign</span> <span class="mf">0.5</span>
<span class="k">hbox</span><span class="p">:</span>
<span class="na">spacing</span> <span class="mi">100</span>
<span class="na">xalign</span> <span class="o">.</span><span class="mi">5</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"Yes"</span><span class="p">)</span> <span class="na">action</span> <span class="n">yes_action</span>
<span class="k">textbutton</span> <span class="n">_</span><span class="p">(</span><span class="s">"No"</span><span class="p">)</span> <span class="na">action</span> <span class="n">no_action</span>
</pre></div>
</div>
</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="config.html" title="Configuration Variables"
>next</a> |</li>
<li class="right" >
<a href="screen_actions.html" title="Screen Actions, Values, and Functions"
>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>
|
