-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclassApplication.html
More file actions
874 lines (796 loc) · 44 KB
/
classApplication.html
File metadata and controls
874 lines (796 loc) · 44 KB
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
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
<!-- HTML header for doxygen 1.15.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hatch Game Engine Documentation: Application Class Reference</title>
<link rel="icon" href="favicon.ico" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="logo.svg" width="55" height="55"/></td>
<td id="projectalign">
<div id="projectname">Hatch Game Engine Documentation<span id="projectnumber"> v1.4.0</span>
</div>
<div id="projectbrief">The documentation for the Hatch Game Engine</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('classApplication.html','','classApplication-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Application Class Reference<div class="ingroups"><a class="el" href="group__hsl.html">HSL</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Functions for manipulating and reading runtime information.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab090f327fc4fde0cad46d203f7b7ea87" id="r_ab090f327fc4fde0cad46d203f7b7ea87"><td class="memItemLeft">array </td><td class="memItemRight"><a class="el" href="#ab090f327fc4fde0cad46d203f7b7ea87">GetCommandLineArguments</a> ()</td></tr>
<tr class="memdesc:ab090f327fc4fde0cad46d203f7b7ea87"><td class="mdescLeft"> </td><td class="mdescRight">Gets a list of the command line arguments passed to the application. <br /></td></tr>
<tr class="memitem:ad4eba3a5c4c09b99af310b2eaaad725e" id="r_ad4eba3a5c4c09b99af310b2eaaad725e"><td class="memItemLeft">string </td><td class="memItemRight"><a class="el" href="#ad4eba3a5c4c09b99af310b2eaaad725e">GetEngineVersionString</a> ()</td></tr>
<tr class="memdesc:ad4eba3a5c4c09b99af310b2eaaad725e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the engine version string. <br /></td></tr>
<tr class="memitem:a3e9f8ab86766cd9b05e560d04ad6ddcc" id="r_a3e9f8ab86766cd9b05e560d04ad6ddcc"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#a3e9f8ab86766cd9b05e560d04ad6ddcc">GetEngineVersionMajor</a> ()</td></tr>
<tr class="memdesc:a3e9f8ab86766cd9b05e560d04ad6ddcc"><td class="mdescLeft"> </td><td class="mdescRight">Gets the major engine version. <br /></td></tr>
<tr class="memitem:aa8dbe49db28ea04fbee807d87db29017" id="r_aa8dbe49db28ea04fbee807d87db29017"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#aa8dbe49db28ea04fbee807d87db29017">GetEngineVersionMinor</a> ()</td></tr>
<tr class="memdesc:aa8dbe49db28ea04fbee807d87db29017"><td class="mdescLeft"> </td><td class="mdescRight">Gets the minor engine version. <br /></td></tr>
<tr class="memitem:a50d14468b596569e5e0be67cfdd4ffdf" id="r_a50d14468b596569e5e0be67cfdd4ffdf"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#a50d14468b596569e5e0be67cfdd4ffdf">GetEngineVersionPatch</a> ()</td></tr>
<tr class="memdesc:a50d14468b596569e5e0be67cfdd4ffdf"><td class="mdescLeft"> </td><td class="mdescRight">Gets the minor engine version. <br /></td></tr>
<tr class="memitem:a70b68fbec0e1132f3062083e859e30c6" id="r_a70b68fbec0e1132f3062083e859e30c6"><td class="memItemLeft">string </td><td class="memItemRight"><a class="el" href="#a70b68fbec0e1132f3062083e859e30c6">GetEngineVersionPrerelease</a> ()</td></tr>
<tr class="memdesc:a70b68fbec0e1132f3062083e859e30c6"><td class="mdescLeft"> </td><td class="mdescRight">Gets the prerelease engine version. <br /></td></tr>
<tr class="memitem:a0d1dc9831c1655944fecb8cc74ce15ea" id="r_a0d1dc9831c1655944fecb8cc74ce15ea"><td class="memItemLeft">string </td><td class="memItemRight"><a class="el" href="#a0d1dc9831c1655944fecb8cc74ce15ea">GetEngineVersionCodename</a> ()</td></tr>
<tr class="memdesc:a0d1dc9831c1655944fecb8cc74ce15ea"><td class="mdescLeft"> </td><td class="mdescRight">Gets the engine version codename. <br /></td></tr>
<tr class="memitem:a38a27ec75d7edade3dc2486ae0dfa251" id="r_a38a27ec75d7edade3dc2486ae0dfa251"><td class="memItemLeft">integer </td><td class="memItemRight"><a class="el" href="#a38a27ec75d7edade3dc2486ae0dfa251">GetTargetFrameRate</a> ()</td></tr>
<tr class="memdesc:a38a27ec75d7edade3dc2486ae0dfa251"><td class="mdescLeft"> </td><td class="mdescRight">Gets the target frame rate of the fixed timestep. <br /></td></tr>
<tr class="memitem:ad005dd5dcc5dcfadeb660ff91ea19933" id="r_ad005dd5dcc5dcfadeb660ff91ea19933"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#ad005dd5dcc5dcfadeb660ff91ea19933">SetTargetFrameRate</a> (integer framerate)</td></tr>
<tr class="memdesc:ad005dd5dcc5dcfadeb660ff91ea19933"><td class="mdescLeft"> </td><td class="mdescRight">Sets the target frame rate of the fixed timestep. <br /></td></tr>
<tr class="memitem:a17594992568837db92c3f3653978e1df" id="r_a17594992568837db92c3f3653978e1df"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a17594992568837db92c3f3653978e1df">UseFixedTimestep</a> (boolean useFixedTimestep)</td></tr>
<tr class="memdesc:a17594992568837db92c3f3653978e1df"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables fixed timestep. This is enabled by default. <br /></td></tr>
<tr class="memitem:a9202dfd8203a48548f63ca99962d09b5" id="r_a9202dfd8203a48548f63ca99962d09b5"><td class="memItemLeft">decimal </td><td class="memItemRight"><a class="el" href="#a9202dfd8203a48548f63ca99962d09b5">GetFPS</a> ()</td></tr>
<tr class="memdesc:a9202dfd8203a48548f63ca99962d09b5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current FPS (frames per second). <br /></td></tr>
<tr class="memitem:a5a95706aff4a5f0dce3b07672570385b" id="r_a5a95706aff4a5f0dce3b07672570385b"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a5a95706aff4a5f0dce3b07672570385b">ShowFPSCounter</a> (boolean show)</td></tr>
<tr class="memdesc:a5a95706aff4a5f0dce3b07672570385b"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the FPS (frames per second) counter. <br /></td></tr>
<tr class="memitem:af37b2e184b5464ca5526ad8ba5a15fed" id="r_af37b2e184b5464ca5526ad8ba5a15fed"><td class="memItemLeft"><a class="el" href="group__hsl.html#ga4b246822d2357bc7be50a0c0211bf26b">KeyBind</a> </td><td class="memItemRight"><a class="el" href="#af37b2e184b5464ca5526ad8ba5a15fed">GetKeyBind</a> (<a class="el" href="group__hsl.html#ga4b246822d2357bc7be50a0c0211bf26b">KeyBind</a> keyBind)</td></tr>
<tr class="memdesc:af37b2e184b5464ca5526ad8ba5a15fed"><td class="mdescLeft"> </td><td class="mdescRight">Gets a keybind. <br /></td></tr>
<tr class="memitem:a748b136cfabd2cb23867ee237e316719" id="r_a748b136cfabd2cb23867ee237e316719"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a748b136cfabd2cb23867ee237e316719">SetKeyBind</a> (<a class="el" href="group__hsl.html#ga4b246822d2357bc7be50a0c0211bf26b">KeyBind</a> keyBind, <a class="el" href="group__hsl.html#gab3c7af4820830f9166ede9e5623c4e73">Key</a> keyID)</td></tr>
<tr class="memdesc:a748b136cfabd2cb23867ee237e316719"><td class="mdescLeft"> </td><td class="mdescRight">Sets a keybind. <br /></td></tr>
<tr class="memitem:ab136817f33da9d4416ab1c71e93a40cd" id="r_ab136817f33da9d4416ab1c71e93a40cd"><td class="memItemLeft"><a id="ab136817f33da9d4416ab1c71e93a40cd" name="ab136817f33da9d4416ab1c71e93a40cd"></a>
void </td><td class="memItemRight"><b>GetGameTitle</b> ()</td></tr>
<tr class="memdesc:ab136817f33da9d4416ab1c71e93a40cd"><td class="mdescLeft"> </td><td class="mdescRight">Gets the game title of the application. <br /></td></tr>
<tr class="memitem:aecfd6c19aba664204c76088377b248ed" id="r_aecfd6c19aba664204c76088377b248ed"><td class="memItemLeft"><a id="aecfd6c19aba664204c76088377b248ed" name="aecfd6c19aba664204c76088377b248ed"></a>
void </td><td class="memItemRight"><b>GetGameTitleShort</b> ()</td></tr>
<tr class="memdesc:aecfd6c19aba664204c76088377b248ed"><td class="mdescLeft"> </td><td class="mdescRight">Gets the short game title of the application. <br /></td></tr>
<tr class="memitem:a3f1b477c44a633208849f0bac5518f91" id="r_a3f1b477c44a633208849f0bac5518f91"><td class="memItemLeft"><a id="a3f1b477c44a633208849f0bac5518f91" name="a3f1b477c44a633208849f0bac5518f91"></a>
void </td><td class="memItemRight"><b>GetGameVersion</b> ()</td></tr>
<tr class="memdesc:a3f1b477c44a633208849f0bac5518f91"><td class="mdescLeft"> </td><td class="mdescRight">Gets the version of the application. <br /></td></tr>
<tr class="memitem:a12d5b6dfa6c77745019bdbb741926eb7" id="r_a12d5b6dfa6c77745019bdbb741926eb7"><td class="memItemLeft"><a id="a12d5b6dfa6c77745019bdbb741926eb7" name="a12d5b6dfa6c77745019bdbb741926eb7"></a>
void </td><td class="memItemRight"><b>GetGameDescription</b> ()</td></tr>
<tr class="memdesc:a12d5b6dfa6c77745019bdbb741926eb7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the description of the game. <br /></td></tr>
<tr class="memitem:ae00974e3600aa9f5aff55f5408c51b73" id="r_ae00974e3600aa9f5aff55f5408c51b73"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#ae00974e3600aa9f5aff55f5408c51b73">SetGameTitle</a> (string title)</td></tr>
<tr class="memdesc:ae00974e3600aa9f5aff55f5408c51b73"><td class="mdescLeft"> </td><td class="mdescRight">Sets the title of the game. <br /></td></tr>
<tr class="memitem:a2c2f45582e88c7409e9e9f1d2184f66a" id="r_a2c2f45582e88c7409e9e9f1d2184f66a"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a2c2f45582e88c7409e9e9f1d2184f66a">SetGameTitleShort</a> (string title)</td></tr>
<tr class="memdesc:a2c2f45582e88c7409e9e9f1d2184f66a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the short title of the game. <br /></td></tr>
<tr class="memitem:a945f7b998156805ef160e8cc720c1dfd" id="r_a945f7b998156805ef160e8cc720c1dfd"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a945f7b998156805ef160e8cc720c1dfd">SetGameVersion</a> (string title)</td></tr>
<tr class="memdesc:a945f7b998156805ef160e8cc720c1dfd"><td class="mdescLeft"> </td><td class="mdescRight">Sets the version of the game. <br /></td></tr>
<tr class="memitem:aff4466608b297c30f31a1a06539edde6" id="r_aff4466608b297c30f31a1a06539edde6"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#aff4466608b297c30f31a1a06539edde6">SetGameDescription</a> (string title)</td></tr>
<tr class="memdesc:aff4466608b297c30f31a1a06539edde6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the description of the game. <br /></td></tr>
<tr class="memitem:a24074e53ffcf45801516aebeb9c32321" id="r_a24074e53ffcf45801516aebeb9c32321"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a24074e53ffcf45801516aebeb9c32321">SetCursorVisible</a> (boolean cursorVisible)</td></tr>
<tr class="memdesc:a24074e53ffcf45801516aebeb9c32321"><td class="mdescLeft"> </td><td class="mdescRight">Sets the visibility of the cursor. <br /></td></tr>
<tr class="memitem:aee0a1f82de572fc51651f1d1392114c3" id="r_aee0a1f82de572fc51651f1d1392114c3"><td class="memItemLeft">boolean </td><td class="memItemRight"><a class="el" href="#aee0a1f82de572fc51651f1d1392114c3">GetCursorVisible</a> ()</td></tr>
<tr class="memdesc:aee0a1f82de572fc51651f1d1392114c3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the visibility of the cursor. <br /></td></tr>
<tr class="memitem:a9585dd41f353d947c8287e663e4619c3" id="r_a9585dd41f353d947c8287e663e4619c3"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a9585dd41f353d947c8287e663e4619c3">TakeScreenshot</a> (string path, function callback)</td></tr>
<tr class="memdesc:a9585dd41f353d947c8287e663e4619c3"><td class="mdescLeft"> </td><td class="mdescRight">Saves a screenshot to <span class="tt">path</span>. This operation only completes at the end of the frame, so you may optionally provide a callback. <br /></td></tr>
<tr class="memitem:a27007a4654e592832fbc44aeda6c9f0e" id="r_a27007a4654e592832fbc44aeda6c9f0e"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a27007a4654e592832fbc44aeda6c9f0e">Error</a> (string message, boolean detailed=true)</td></tr>
<tr class="memdesc:a27007a4654e592832fbc44aeda6c9f0e"><td class="mdescLeft"> </td><td class="mdescRight">Shows an error message to the user through a dialog box, if possible. The error message is also logged. <br /></td></tr>
<tr class="memitem:a46940d8b4a52db72ba3fabf86526b29d" id="r_a46940d8b4a52db72ba3fabf86526b29d"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a46940d8b4a52db72ba3fabf86526b29d">SetDefaultFont</a> (string font)</td></tr>
<tr class="memdesc:a46940d8b4a52db72ba3fabf86526b29d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the default font to the given Resource path, or array containing Resource paths. <br /></td></tr>
<tr class="memitem:a21fd12d58929d0618dbc2136e5f6060e" id="r_a21fd12d58929d0618dbc2136e5f6060e"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="#a21fd12d58929d0618dbc2136e5f6060e">SetDefaultFont</a> (array font)</td></tr>
<tr class="memdesc:a21fd12d58929d0618dbc2136e5f6060e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the default font to the given Resource path, or array containing Resource paths. <br /></td></tr>
<tr class="memitem:a86990e86ba999635ccf4af5474d8d758" id="r_a86990e86ba999635ccf4af5474d8d758"><td class="memItemLeft">boolean </td><td class="memItemRight"><a class="el" href="#a86990e86ba999635ccf4af5474d8d758">ChangeGame</a> (string path, string startingScene, array cmdLineArgs)</td></tr>
<tr class="memdesc:a86990e86ba999635ccf4af5474d8d758"><td class="mdescLeft"> </td><td class="mdescRight">Changes the current game, by loading a data file containing the new game. <br /></td></tr>
<tr class="memitem:a657e7bfc4148458196f71bbc02f60b72" id="r_a657e7bfc4148458196f71bbc02f60b72"><td class="memItemLeft"><a id="a657e7bfc4148458196f71bbc02f60b72" name="a657e7bfc4148458196f71bbc02f60b72"></a>
void </td><td class="memItemRight"><b>Quit</b> ()</td></tr>
<tr class="memdesc:a657e7bfc4148458196f71bbc02f60b72"><td class="mdescLeft"> </td><td class="mdescRight">Closes the application. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions for manipulating and reading runtime information. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a86990e86ba999635ccf4af5474d8d758" name="a86990e86ba999635ccf4af5474d8d758"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86990e86ba999635ccf4af5474d8d758">◆ </a></span>ChangeGame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Application.ChangeGame </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>startingScene</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">array</td> <td class="paramname"><span class="paramname"><em>cmdLineArgs</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the current game, by loading a data file containing the new game. </p>
<p>If the path ends with a path separator (<span class="tt">/</span>), an entire directory will be loaded as the game instead. Only <span class="tt">game://</span> and <span class="tt">user://</span> URLs are supported (or an absolute path that resolves to those locations).<br />
<br />
This is permanent for as long as the application is running, so restarting the application using the associated developer key (<a class="el" href="group__hsl.html#gga4b246822d2357bc7be50a0c0211bf26ba53a46f507e6dd16fd8d1f769cc1e543c" title="KeyBind_DevRestartApp">KeyBind_DevRestartApp</a>) will reload the current game, and not the one the application started with. Script compiling is also disabled after the game changes.<br />
<br />
The change only takes effect after a frame completes.<br />
<br />
Note that certain game configurations will persist between games if not set by the new GameConfig:</p><ul>
<li>
Game-identifying configurations:<ul>
<li>
Game title (including the short game title)</li>
<li>
Game version</li>
<li>
Game description</li>
<li>
Game developer</li>
<li>
Game identifier</li>
<li>
Developer identifier</li>
</ul>
</li>
<li>
Paths:<ul>
<li>
Saves directory</li>
<li>
Preferences directory</li>
</ul>
</li>
<li>
Engine configurations:<ul>
<li>
Window size</li>
<li>
Audio volume</li>
<li>
Target frame rate</li>
<li>
Whether fixed timestep was enabled or disabled with <span class="tt">useFixedTimestep</span></li>
<li>
Settings filename<ul>
<li>
</li>
</ul>
this is changed, the current settings are discarded (not saved) and the new settings file is loaded. If the file does not exist, however, default settings will be loaded.</li>
</ul>
</li>
</ul>
<p>Some of the game's current state also persists between games:</p><ul>
<li>
Command line arguments (unless <em class="arg">cmdLineArgs</em> is passed to this function)</li>
<li>
Palette colors</li>
<li>
Whether palette rendering is enabled</li>
<li>
Whether software rendering was enabled or disabled with <span class="tt">useSoftwareRenderer</span></li>
</ul>
<p>The following <b>does not</b> persist between games:</p><ul>
<li>
Any loaded resources</li>
<li>
Any persistent entities</li>
<li>
Scripting state</li>
</ul>
<p>The following <b>cannot</b> be changed between games:</p><ul>
<li>
Log file name</li>
<li>
Graphics rendering backend</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path of the data file to load. </td></tr>
<tr><td class="paramname">startingScene</td><td>The filename of the scene file to load upon changing the game. Note that restarting the game will load the starting scene defined in its GameConfig instead. Passing <span class="tt">null</span> to this argument is equivalent to not passing it at all. </td></tr>
<tr><td class="paramname">cmdLineArgs</td><td>An array of strings containing the command line arguments to pass to the new game. If any of the values are not strings, they will be converted to a string representation. If this argument is not given, the current command line arguments will be passed to the new game. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns whether the game will change. </dd></dl>
</div>
</div>
<a id="a27007a4654e592832fbc44aeda6c9f0e" name="a27007a4654e592832fbc44aeda6c9f0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27007a4654e592832fbc44aeda6c9f0e">◆ </a></span>Error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.Error </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>message</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean</td> <td class="paramname"><span class="paramname"><em>detailed</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows an error message to the user through a dialog box, if possible. The error message is also logged. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The error message to show to the user. </td></tr>
<tr><td class="paramname">detailed</td><td>Whether to show the stack trace alongside the error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab090f327fc4fde0cad46d203f7b7ea87" name="ab090f327fc4fde0cad46d203f7b7ea87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab090f327fc4fde0cad46d203f7b7ea87">◆ </a></span>GetCommandLineArguments()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">array Application.GetCommandLineArguments </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a list of the command line arguments passed to the application. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an array of string values. </dd></dl>
</div>
</div>
<a id="aee0a1f82de572fc51651f1d1392114c3" name="aee0a1f82de572fc51651f1d1392114c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee0a1f82de572fc51651f1d1392114c3">◆ </a></span>GetCursorVisible()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Application.GetCursorVisible </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the visibility of the cursor. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns whether the cursor is visible. </dd></dl>
</div>
</div>
<a id="a0d1dc9831c1655944fecb8cc74ce15ea" name="a0d1dc9831c1655944fecb8cc74ce15ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d1dc9831c1655944fecb8cc74ce15ea">◆ </a></span>GetEngineVersionCodename()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Application.GetEngineVersionCodename </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the engine version codename. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string value, or <span class="tt">null</span>. </dd></dl>
</div>
</div>
<a id="a3e9f8ab86766cd9b05e560d04ad6ddcc" name="a3e9f8ab86766cd9b05e560d04ad6ddcc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e9f8ab86766cd9b05e560d04ad6ddcc">◆ </a></span>GetEngineVersionMajor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer Application.GetEngineVersionMajor </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the major engine version. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value. </dd></dl>
</div>
</div>
<a id="aa8dbe49db28ea04fbee807d87db29017" name="aa8dbe49db28ea04fbee807d87db29017"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8dbe49db28ea04fbee807d87db29017">◆ </a></span>GetEngineVersionMinor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer Application.GetEngineVersionMinor </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the minor engine version. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value. </dd></dl>
</div>
</div>
<a id="a50d14468b596569e5e0be67cfdd4ffdf" name="a50d14468b596569e5e0be67cfdd4ffdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50d14468b596569e5e0be67cfdd4ffdf">◆ </a></span>GetEngineVersionPatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer Application.GetEngineVersionPatch </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the minor engine version. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value. </dd></dl>
</div>
</div>
<a id="a70b68fbec0e1132f3062083e859e30c6" name="a70b68fbec0e1132f3062083e859e30c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70b68fbec0e1132f3062083e859e30c6">◆ </a></span>GetEngineVersionPrerelease()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Application.GetEngineVersionPrerelease </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the prerelease engine version. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string value, or <span class="tt">null</span>. </dd></dl>
</div>
</div>
<a id="ad4eba3a5c4c09b99af310b2eaaad725e" name="ad4eba3a5c4c09b99af310b2eaaad725e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4eba3a5c4c09b99af310b2eaaad725e">◆ </a></span>GetEngineVersionString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Application.GetEngineVersionString </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the engine version string. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string value. </dd></dl>
</div>
</div>
<a id="a9202dfd8203a48548f63ca99962d09b5" name="a9202dfd8203a48548f63ca99962d09b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9202dfd8203a48548f63ca99962d09b5">◆ </a></span>GetFPS()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decimal Application.GetFPS </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current FPS (frames per second). </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a decimal value. </dd></dl>
</div>
</div>
<a id="af37b2e184b5464ca5526ad8ba5a15fed" name="af37b2e184b5464ca5526ad8ba5a15fed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af37b2e184b5464ca5526ad8ba5a15fed">◆ </a></span>GetKeyBind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__hsl.html#ga4b246822d2357bc7be50a0c0211bf26b">KeyBind</a> Application.GetKeyBind </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__hsl.html#ga4b246822d2357bc7be50a0c0211bf26b">KeyBind</a></td> <td class="paramname"><span class="paramname"><em>keyBind</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a keybind. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyBind</td><td>The keybind. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the key ID of the keybind. </dd></dl>
</div>
</div>
<a id="a38a27ec75d7edade3dc2486ae0dfa251" name="a38a27ec75d7edade3dc2486ae0dfa251"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38a27ec75d7edade3dc2486ae0dfa251">◆ </a></span>GetTargetFrameRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer Application.GetTargetFrameRate </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the target frame rate of the fixed timestep. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer value. </dd></dl>
</div>
</div>
<a id="a24074e53ffcf45801516aebeb9c32321" name="a24074e53ffcf45801516aebeb9c32321"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24074e53ffcf45801516aebeb9c32321">◆ </a></span>SetCursorVisible()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetCursorVisible </td>
<td>(</td>
<td class="paramtype">boolean</td> <td class="paramname"><span class="paramname"><em>cursorVisible</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the visibility of the cursor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cursorVisible</td><td>Whether the cursor is visible. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a21fd12d58929d0618dbc2136e5f6060e" name="a21fd12d58929d0618dbc2136e5f6060e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21fd12d58929d0618dbc2136e5f6060e">◆ </a></span>SetDefaultFont() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetDefaultFont </td>
<td>(</td>
<td class="paramtype">array</td> <td class="paramname"><span class="paramname"><em>font</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the default font to the given Resource path, or array containing Resource paths. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>The list of fonts. Passing <span class="tt">null</span> to this argument will change the default font to the one the application was built with, if one is present. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a46940d8b4a52db72ba3fabf86526b29d" name="a46940d8b4a52db72ba3fabf86526b29d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46940d8b4a52db72ba3fabf86526b29d">◆ </a></span>SetDefaultFont() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetDefaultFont </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>font</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the default font to the given Resource path, or array containing Resource paths. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">font</td><td>The font. Passing <span class="tt">null</span> to this argument will change the default font to the one the application was built with, if one is present. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aff4466608b297c30f31a1a06539edde6" name="aff4466608b297c30f31a1a06539edde6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff4466608b297c30f31a1a06539edde6">◆ </a></span>SetGameDescription()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetGameDescription </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>title</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the description of the game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">title</td><td>Game description. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae00974e3600aa9f5aff55f5408c51b73" name="ae00974e3600aa9f5aff55f5408c51b73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae00974e3600aa9f5aff55f5408c51b73">◆ </a></span>SetGameTitle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetGameTitle </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>title</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the title of the game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">title</td><td>Game title. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2c2f45582e88c7409e9e9f1d2184f66a" name="a2c2f45582e88c7409e9e9f1d2184f66a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c2f45582e88c7409e9e9f1d2184f66a">◆ </a></span>SetGameTitleShort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetGameTitleShort </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>title</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the short title of the game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">title</td><td>Short game title. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a945f7b998156805ef160e8cc720c1dfd" name="a945f7b998156805ef160e8cc720c1dfd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a945f7b998156805ef160e8cc720c1dfd">◆ </a></span>SetGameVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetGameVersion </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>title</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the version of the game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">title</td><td>Game version. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a748b136cfabd2cb23867ee237e316719" name="a748b136cfabd2cb23867ee237e316719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748b136cfabd2cb23867ee237e316719">◆ </a></span>SetKeyBind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetKeyBind </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__hsl.html#ga4b246822d2357bc7be50a0c0211bf26b">KeyBind</a></td> <td class="paramname"><span class="paramname"><em>keyBind</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__hsl.html#gab3c7af4820830f9166ede9e5623c4e73">Key</a></td> <td class="paramname"><span class="paramname"><em>keyID</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a keybind. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keyBind</td><td>The keybind. </td></tr>
<tr><td class="paramname">keyID</td><td>The key ID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad005dd5dcc5dcfadeb660ff91ea19933" name="ad005dd5dcc5dcfadeb660ff91ea19933"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad005dd5dcc5dcfadeb660ff91ea19933">◆ </a></span>SetTargetFrameRate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.SetTargetFrameRate </td>
<td>(</td>
<td class="paramtype">integer</td> <td class="paramname"><span class="paramname"><em>framerate</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the target frame rate of the fixed timestep. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framerate</td><td>The target frame rate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5a95706aff4a5f0dce3b07672570385b" name="a5a95706aff4a5f0dce3b07672570385b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a95706aff4a5f0dce3b07672570385b">◆ </a></span>ShowFPSCounter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.ShowFPSCounter </td>
<td>(</td>
<td class="paramtype">boolean</td> <td class="paramname"><span class="paramname"><em>show</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the FPS (frames per second) counter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">show</td><td>Whether to show the FPS counter. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9585dd41f353d947c8287e663e4619c3" name="a9585dd41f353d947c8287e663e4619c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9585dd41f353d947c8287e663e4619c3">◆ </a></span>TakeScreenshot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.TakeScreenshot </td>
<td>(</td>
<td class="paramtype">string</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">function</td> <td class="paramname"><span class="paramname"><em>callback</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Saves a screenshot to <span class="tt">path</span>. This operation only completes at the end of the frame, so you may optionally provide a callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The path to save the screenshot to. If not passed, the screenshot is saved to the default screenshot path. </td></tr>
<tr><td class="paramname">callback</td><td>The function to call when the screenshot operation finishes. When called, it receives two arguments: a boolean indicating whether the screenshot was saved, and the path the screenshot was saved to, as a string. The function may have less than two parameters, but no more than two. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17594992568837db92c3f3653978e1df" name="a17594992568837db92c3f3653978e1df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17594992568837db92c3f3653978e1df">◆ </a></span>UseFixedTimestep()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Application.UseFixedTimestep </td>
<td>(</td>
<td class="paramtype">boolean</td> <td class="paramname"><span class="paramname"><em>useFixedTimestep</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables fixed timestep. This is enabled by default. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">useFixedTimestep</td><td>Whether to use fixed timestep. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="classApplication.html">Application</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.0 </li>
</ul>
</div>
</body>
</html>