-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathuser.html
More file actions
467 lines (434 loc) · 32.7 KB
/
user.html
File metadata and controls
467 lines (434 loc) · 32.7 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
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="next" title="Module GameState" href="userapi/state/index.html"><link rel="prev" title="Room" href="guide/resourcetypes/room.html">
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
<title>User Docs - RPG++ documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="_static/lua.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
<style>
body {
--color-code-background: #f2f2f2;
--color-code-foreground: #1e1e1e;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">RPG++ documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">RPG++ documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<p class="caption" role="heading"><span class="caption-text">User Guide:</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="guide.html">User Guide</a><input aria-label="Toggle navigation of User Guide" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="guide/install.html">Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/newproject.html">Make a New Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="guide/mainconcepts.html">Main Concepts</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="guide/typesindex.html">Resource Types</a><input aria-label="Toggle navigation of Resource Types" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="guide/resourcetypes/tileset.html">TileSet</a></li>
<li class="toctree-l3"><a class="reference internal" href="guide/resourcetypes/room.html">Room</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Scripting:</span></p>
<ul class="current">
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">User Docs</a><input aria-label="Toggle navigation of User Docs" checked="" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="userapi/state/index.html">Module <code class="docutils literal notranslate"><span class="pre">GameState</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/world/index.html">Module <code class="docutils literal notranslate"><span class="pre">WorldService</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/sounds/index.html">Module <code class="docutils literal notranslate"><span class="pre">Sounds</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/interface/index.html">Module <code class="docutils literal notranslate"><span class="pre">Interface</span></code></a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developers:</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="dev.html">Developer Docs</a><input aria-label="Toggle navigation of Developer Docs" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="dev-additional/compile.html">Compiling RPG++</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="Dev/classlist.html">Class list</a><input aria-label="Toggle navigation of Class list" class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classActor.html">Class Actor</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classActorContainer.html">Class ActorContainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classAtlasTile.html">Class AtlasTile</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classBaseContainer.html">Class BaseContainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classCollisionsContainer.html">Class CollisionsContainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classColorRect.html">Class ColorRect</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classDialogue.html">Class Dialogue</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classDialogueBalloon.html">Class DialogueBalloon</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classGame.html">Class Game</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classISaveable.html">Class ISaveable</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classImageRect.html">Class ImageRect</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classInteractable.html">Class Interactable</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classInteractablesContainer.html">Class InteractablesContainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classInterfaceService.html">Class InterfaceService</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classInterfaceView.html">Class InterfaceView</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classPlayer.html">Class Player</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classProp.html">Class Prop</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classPropsContainer.html">Class PropsContainer</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classResourceService.html">Class ResourceService</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classRoom.html">Class Room</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classScriptFile.html">Class ScriptFile</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classScriptService.html">Class ScriptService</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classSoundService.html">Class SoundService</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classStateService.html">Class StateService</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classTextArea.html">Class TextArea</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classTile.html">Class Tile</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classTileMap.html">Class TileMap</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classTileSet.html">Class TileSet</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classUIElement.html">Class UIElement</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classWorldService.html">Class WorldService</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classmINI_1_1INIFile.html">Class mINI::INIFile</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classmINI_1_1INIGenerator.html">Class mINI::INIGenerator</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classmINI_1_1INIMap.html">Class mINI::INIMap</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classmINI_1_1INIReader.html">Class mINI::INIReader</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/class/classmINI_1_1INIWriter.html">Class mINI::INIWriter</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="Dev/structlist.html">Struct list</a><input aria-label="Toggle navigation of Struct list" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structActorBin.html">Struct ActorBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structActorInRoomBin.html">Struct ActorInRoomBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structDataSerialization.html">Struct DataSerialization</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structDialogueBin.html">Struct DialogueBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structDialogueLine.html">Struct DialogueLine</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structDialogueTextSection.html">Struct DialogueTextSection</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structGameBinSettings.html">Struct GameBinSettings</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structGameData.html">Struct GameData</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structIRect.html">Struct IRect</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structIVector.html">Struct IVector</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structImageBin.html">Struct ImageBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structInteractableBin.html">Struct InteractableBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structInteractableInRoomBin.html">Struct InteractableInRoomBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structMusicBin.html">Struct MusicBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structPropBin.html">Struct PropBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structPropInRoomBin.html">Struct PropInRoomBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structRoomBin.html">Struct RoomBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structScriptBin.html">Struct ScriptBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structTileBin.html">Struct TileBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structTileSetBin.html">Struct TileSetBin</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/struct/structVsInfo.html">Struct VsInfo</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="Dev/filelist.html">File list</a><input aria-label="Toggle navigation of File list" class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/actorContainer_8hpp.html">File actorContainer.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/actor_8hpp.html">File actor.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/atlasTile_8hpp.html">File atlasTile.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/baseContainer_8hpp.html">File baseContainer.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/collisionsContainer_8hpp.html">File collisionsContainer.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/colorRect_8hpp.html">File colorRect.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/conversion_8hpp.html">File conversion.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/dialogueBalloon_8hpp.html">File dialogueBalloon.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/dialogueParser_8hpp.html">File dialogueParser.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/dialogue_8hpp.html">File dialogue.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/game_8hpp.html">File game.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/gamedata_8hpp.html">File gamedata.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/imageRect_8hpp.html">File imageRect.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/ini_8h.html">File ini.h</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/interactable_8hpp.html">File interactable.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/interactablesContainer_8hpp.html">File interactablesContainer.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/interfaceService_8hpp.html">File interfaceService.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/interfaceView_8hpp.html">File interfaceView.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/player_8hpp.html">File player.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/prop_8hpp.html">File prop.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/propsContainer_8hpp.html">File propsContainer.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/resourceService_8hpp.html">File resourceService.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/room_8hpp.html">File room.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/saveable_8hpp.html">File saveable.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/scriptFile_8h.html">File scriptFile.h</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/scriptService_8hpp.html">File scriptService.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/soundService_8hpp.html">File soundService.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/stateService_8hpp.html">File stateService.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/textArea_8hpp.html">File textArea.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/tile_8hpp.html">File tile.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/tilemap_8hpp.html">File tilemap.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/tileset_8hpp.html">File tileset.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/uiElement_8hpp.html">File uiElement.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/winapi_8hpp.html">File winapi.hpp</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/file/worldService_8hpp.html">File worldService.hpp</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="Dev/namespacelist.html">Namespace list</a><input aria-label="Toggle navigation of Namespace list" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l3"><a class="reference internal" href="Dev/namespace/namespacemINI.html">Namespace mINI</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/namespace/namespacemINI_1_1INIParser.html">Namespace mINI::INIParser</a></li>
<li class="toctree-l3"><a class="reference internal" href="Dev/namespace/namespacemINI_1_1INIStringUtil.html">Namespace mINI::INIStringUtil</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="view-this-page">
<a class="muted-link" href="_sources/user.rst.txt" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div>
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="user-docs">
<h1>User Docs<a class="headerlink" href="#user-docs" title="Link to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="userapi/state/index.html">Module <code class="docutils literal notranslate"><span class="pre">GameState</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="userapi/state/index.html#index">Index</a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/state/index.html#api-reference">Api reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="userapi/state/index.html#lua-GameState.Get"><code class="docutils literal notranslate"><span class="pre">GameState.Get()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="userapi/state/index.html#lua-GameState.Set"><code class="docutils literal notranslate"><span class="pre">GameState.Set()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="userapi/world/index.html">Module <code class="docutils literal notranslate"><span class="pre">WorldService</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="userapi/world/index.html#index">Index</a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/world/index.html#api-reference">Api reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="userapi/world/index.html#lua-WorldService.GetPlayer"><code class="docutils literal notranslate"><span class="pre">WorldService.GetPlayer()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="userapi/world/index.html#lua-WorldService.SetRoom"><code class="docutils literal notranslate"><span class="pre">WorldService.SetRoom()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="userapi/world/index.html#lua-WorldService.GetRoom"><code class="docutils literal notranslate"><span class="pre">WorldService.GetRoom()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="userapi/sounds/index.html">Module <code class="docutils literal notranslate"><span class="pre">Sounds</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="userapi/sounds/index.html#index">Index</a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/sounds/index.html#api-reference">Api reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="userapi/sounds/index.html#lua-Sounds.PlaySound"><code class="docutils literal notranslate"><span class="pre">Sounds.PlaySound()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="userapi/sounds/index.html#lua-Sounds.LoadMusic"><code class="docutils literal notranslate"><span class="pre">Sounds.LoadMusic()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="userapi/sounds/index.html#lua-Sounds.PlayMusic"><code class="docutils literal notranslate"><span class="pre">Sounds.PlayMusic()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="userapi/interface/index.html">Module <code class="docutils literal notranslate"><span class="pre">Interface</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="userapi/interface/index.html#index">Index</a></li>
<li class="toctree-l2"><a class="reference internal" href="userapi/interface/index.html#api-reference">Api reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="userapi/interface/index.html#lua-Interface.OpenDialogue"><code class="docutils literal notranslate"><span class="pre">Interface.OpenDialogue()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="userapi/state/index.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Module <code class="docutils literal notranslate"><span class="pre">GameState</span></code></div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="guide/resourcetypes/room.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Room</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2026, RPG++ Contributors
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer no-toc">
</aside>
</div>
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
</body>
</html>