-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnamespaceModAPI_1_1SaveData.html
More file actions
553 lines (511 loc) · 31.4 KB
/
namespaceModAPI_1_1SaveData.html
File metadata and controls
553 lines (511 loc) · 31.4 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
<!-- HTML header for doxygen 1.16.1-->
<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MIO Modding API: ModAPI::SaveData Namespace Reference</title>
<!--BEGIN PROJECT_ICON-->
<link rel="icon" href="$projecticon" type="image/x-icon" />
<!--END PROJECT_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>
<!--BEGIN COPY_CLIPBOARD-->
<script type="text/javascript" src="clipboard.js"></script>
<!--END COPY_CLIPBOARD-->
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeFragmentCopyButton.title = "Copy Code Fragment"
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
</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="projectalign">
<div id="projectname">MIO Modding API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('namespaceModAPI_1_1SaveData.html',''); initResizable(); });
/* @license-end */
</script>
<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="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">ModAPI::SaveData Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Functions for reading and manipulating entries in the internal save data array.
<a href="namespaceModAPI_1_1SaveData.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1GameString.html">GameString</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A null-terminated string as stored internally by the game. <a href="structModAPI_1_1SaveData_1_1GameString.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">SaveEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A single save data entry as it appears in the game's save array. <a href="structModAPI_1_1SaveData_1_1SaveEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntryValue.html">SaveEntryValue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The value payload of a save data entry. <a href="structModAPI_1_1SaveData_1_1SaveEntryValue.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ada3b9307ae32df7fe04171ba03663fcd" id="r_ada3b9307ae32df7fe04171ba03663fcd"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structModAPI_1_1SaveData_1_1GameString.html">ModAPI::SaveData::GameString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#ada3b9307ae32df7fe04171ba03663fcd">GameString</a></td></tr>
<tr class="memdesc:ada3b9307ae32df7fe04171ba03663fcd"><td class="mdescLeft"> </td><td class="mdescRight">A null-terminated string as stored internally by the game. <br /></td></tr>
<tr class="separator:ada3b9307ae32df7fe04171ba03663fcd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07bc95082832beb142106c5967f64746" id="r_a07bc95082832beb142106c5967f64746"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntryValue.html">ModAPI::SaveData::SaveEntryValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a07bc95082832beb142106c5967f64746">SaveEntryValue</a></td></tr>
<tr class="memdesc:a07bc95082832beb142106c5967f64746"><td class="mdescLeft"> </td><td class="mdescRight">The value payload of a save data entry. <br /></td></tr>
<tr class="separator:a07bc95082832beb142106c5967f64746"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25299fa48e5ad8de20787938c27f2bcf" id="r_a25299fa48e5ad8de20787938c27f2bcf"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">ModAPI::SaveData::SaveEntry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a25299fa48e5ad8de20787938c27f2bcf">SaveEntry</a></td></tr>
<tr class="memdesc:a25299fa48e5ad8de20787938c27f2bcf"><td class="mdescLeft"> </td><td class="mdescRight">A single save data entry as it appears in the game's save array. <br /></td></tr>
<tr class="separator:a25299fa48e5ad8de20787938c27f2bcf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a607a5b8c80ab31392189d12e16d8aaa7" id="r_a607a5b8c80ab31392189d12e16d8aaa7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a607a5b8c80ab31392189d12e16d8aaa7">GetSaveEntryCount</a> ()</td></tr>
<tr class="memdesc:a607a5b8c80ab31392189d12e16d8aaa7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the total number of entries in the save data array. <br /></td></tr>
<tr class="separator:a607a5b8c80ab31392189d12e16d8aaa7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac793155b907d48008a2e415e5c3e78a6" id="r_ac793155b907d48008a2e415e5c3e78a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">SaveEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#ac793155b907d48008a2e415e5c3e78a6">GetSaveEntryByIndex</a> (int index)</td></tr>
<tr class="memdesc:ac793155b907d48008a2e415e5c3e78a6"><td class="mdescLeft"> </td><td class="mdescRight">Gets a save entry by its index in the save data array. <br /></td></tr>
<tr class="separator:ac793155b907d48008a2e415e5c3e78a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaf319e72822829fb5ea5029cf3ba578" id="r_abaf319e72822829fb5ea5029cf3ba578"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">SaveEntry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#abaf319e72822829fb5ea5029cf3ba578">GetSaveEntry</a> (const char *name)</td></tr>
<tr class="memdesc:abaf319e72822829fb5ea5029cf3ba578"><td class="mdescLeft"> </td><td class="mdescRight">Gets a save entry by its key/name. <br /></td></tr>
<tr class="separator:abaf319e72822829fb5ea5029cf3ba578"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c332c10a28eb0ec7f65ae94df3d6759" id="r_a8c332c10a28eb0ec7f65ae94df3d6759"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a8c332c10a28eb0ec7f65ae94df3d6759">SaveEntryExists</a> (const char *name)</td></tr>
<tr class="memdesc:a8c332c10a28eb0ec7f65ae94df3d6759"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a save entry with the given key/name exists. <br /></td></tr>
<tr class="separator:a8c332c10a28eb0ec7f65ae94df3d6759"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52a563ee5c8a75cc1f960b792bef8a66" id="r_a52a563ee5c8a75cc1f960b792bef8a66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a52a563ee5c8a75cc1f960b792bef8a66">GetSaveEntryName</a> (int index)</td></tr>
<tr class="memdesc:a52a563ee5c8a75cc1f960b792bef8a66"><td class="mdescLeft"> </td><td class="mdescRight">Gets the key/name of a save entry by its index. <br /></td></tr>
<tr class="separator:a52a563ee5c8a75cc1f960b792bef8a66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2b58b60f3a3efd5feb2ac2e3108229f" id="r_ad2b58b60f3a3efd5feb2ac2e3108229f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#ad2b58b60f3a3efd5feb2ac2e3108229f">GetSaveEntryValueCount</a> (const char *name, int32_t *outCount)</td></tr>
<tr class="memdesc:ad2b58b60f3a3efd5feb2ac2e3108229f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the count value of a save entry. <br /></td></tr>
<tr class="separator:ad2b58b60f3a3efd5feb2ac2e3108229f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a150ef74e49e0a35c43ee3458bac4761c" id="r_a150ef74e49e0a35c43ee3458bac4761c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a150ef74e49e0a35c43ee3458bac4761c">SetSaveEntryValueCount</a> (const char *name, int32_t count)</td></tr>
<tr class="memdesc:a150ef74e49e0a35c43ee3458bac4761c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the count value of a save entry. <br /></td></tr>
<tr class="separator:a150ef74e49e0a35c43ee3458bac4761c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b50599f7d27769db75f9b723524507a" id="r_a3b50599f7d27769db75f9b723524507a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a3b50599f7d27769db75f9b723524507a">GetSaveEntryValueFlags</a> (const char *name, uint32_t *outFlags)</td></tr>
<tr class="memdesc:a3b50599f7d27769db75f9b723524507a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the flags of a save entry. <br /></td></tr>
<tr class="separator:a3b50599f7d27769db75f9b723524507a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ce196abfcfae9807ae88bb13936dad1" id="r_a6ce196abfcfae9807ae88bb13936dad1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a6ce196abfcfae9807ae88bb13936dad1">SetSaveEntryValueFlags</a> (const char *name, uint32_t flags)</td></tr>
<tr class="memdesc:a6ce196abfcfae9807ae88bb13936dad1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the flags of a save entry. <br /></td></tr>
<tr class="separator:a6ce196abfcfae9807ae88bb13936dad1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a77266901ea3f37f040b570804da9893d" id="r_a77266901ea3f37f040b570804da9893d"><td class="memItemLeft" align="right" valign="top">uint32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1SaveData.html#a77266901ea3f37f040b570804da9893d">g_SaveArraySize</a> = nullptr</td></tr>
<tr class="memdesc:a77266901ea3f37f040b570804da9893d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the number of entries in the save data array. <br /></td></tr>
<tr class="separator:a77266901ea3f37f040b570804da9893d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions for reading and manipulating entries in the internal save data array. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="ada3b9307ae32df7fe04171ba03663fcd" name="ada3b9307ae32df7fe04171ba03663fcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada3b9307ae32df7fe04171ba03663fcd">◆ </a></span>GameString</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structModAPI_1_1SaveData_1_1GameString.html">ModAPI::SaveData::GameString</a> <a class="el" href="structModAPI_1_1SaveData_1_1GameString.html">ModAPI::SaveData::GameString</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A null-terminated string as stored internally by the game. </p>
<dl class="section note"><dt>Note</dt><dd>Do not modify the fields of this struct directly. </dd></dl>
</div>
</div>
<a id="a25299fa48e5ad8de20787938c27f2bcf" name="a25299fa48e5ad8de20787938c27f2bcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25299fa48e5ad8de20787938c27f2bcf">◆ </a></span>SaveEntry</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">ModAPI::SaveData::SaveEntry</a> <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">ModAPI::SaveData::SaveEntry</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A single save data entry as it appears in the game's save array. </p>
<p>Retrieve instances via <a class="el" href="namespaceModAPI_1_1SaveData.html#abaf319e72822829fb5ea5029cf3ba578" title="Gets a save entry by its key/name.">GetSaveEntry()</a> or <a class="el" href="namespaceModAPI_1_1SaveData.html#ac793155b907d48008a2e415e5c3e78a6" title="Gets a save entry by its index in the save data array.">GetSaveEntryByIndex()</a>. Do not construct this struct manually. </p>
</div>
</div>
<a id="a07bc95082832beb142106c5967f64746" name="a07bc95082832beb142106c5967f64746"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07bc95082832beb142106c5967f64746">◆ </a></span>SaveEntryValue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntryValue.html">ModAPI::SaveData::SaveEntryValue</a> <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntryValue.html">ModAPI::SaveData::SaveEntryValue</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The value payload of a save data entry. </p>
<dl class="section note"><dt>Note</dt><dd>Do not modify the fields of this struct directly. </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="abaf319e72822829fb5ea5029cf3ba578" name="abaf319e72822829fb5ea5029cf3ba578"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaf319e72822829fb5ea5029cf3ba578">◆ </a></span>GetSaveEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">SaveEntry</a> * ModAPI::SaveData::GetSaveEntry </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a save entry by its key/name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The key/name of the the entry to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html" title="A single save data entry as it appears in the game's save array.">SaveEntry</a>, or nullptr if not found. </dd></dl>
</div>
</div>
<a id="ac793155b907d48008a2e415e5c3e78a6" name="ac793155b907d48008a2e415e5c3e78a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac793155b907d48008a2e415e5c3e78a6">◆ </a></span>GetSaveEntryByIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">SaveEntry</a> * ModAPI::SaveData::GetSaveEntryByIndex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a save entry by its index in the save data array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Zero-based index of the entry </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the <a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html" title="A single save data entry as it appears in the game's save array.">SaveEntry</a>, or nullptr if the index is out of range. </dd></dl>
</div>
</div>
<a id="a607a5b8c80ab31392189d12e16d8aaa7" name="a607a5b8c80ab31392189d12e16d8aaa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a607a5b8c80ab31392189d12e16d8aaa7">◆ </a></span>GetSaveEntryCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> int ModAPI::SaveData::GetSaveEntryCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the total number of entries in the save data array. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of save entries as an integer. </dd></dl>
</div>
</div>
<a id="a52a563ee5c8a75cc1f960b792bef8a66" name="a52a563ee5c8a75cc1f960b792bef8a66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52a563ee5c8a75cc1f960b792bef8a66">◆ </a></span>GetSaveEntryName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> const char * ModAPI::SaveData::GetSaveEntryName </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the key/name of a save entry by its index. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Zero-based index of the entry. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The name of the entry, or nullptr if the index is out of range. </dd></dl>
</div>
</div>
<a id="ad2b58b60f3a3efd5feb2ac2e3108229f" name="ad2b58b60f3a3efd5feb2ac2e3108229f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2b58b60f3a3efd5feb2ac2e3108229f">◆ </a></span>GetSaveEntryValueCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::SaveData::GetSaveEntryValueCount </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>outCount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the count value of a save entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The key/name of the entry. </td></tr>
<tr><td class="paramname">outCount</td><td>Pointer to an int32_t to receive the count value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the entry was not found. </dd></dl>
</div>
</div>
<a id="a3b50599f7d27769db75f9b723524507a" name="a3b50599f7d27769db75f9b723524507a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b50599f7d27769db75f9b723524507a">◆ </a></span>GetSaveEntryValueFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::SaveData::GetSaveEntryValueFlags </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>outFlags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the flags of a save entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The key/name of the entry. </td></tr>
<tr><td class="paramname">outFlags</td><td>Pointer to a uint32_t to receive the flags value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the entry was not found. </dd></dl>
</div>
</div>
<a id="a8c332c10a28eb0ec7f65ae94df3d6759" name="a8c332c10a28eb0ec7f65ae94df3d6759"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c332c10a28eb0ec7f65ae94df3d6759">◆ </a></span>SaveEntryExists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::SaveData::SaveEntryExists </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a save entry with the given key/name exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The key/name to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the entry exists, false otherwise. </dd></dl>
</div>
</div>
<a id="a150ef74e49e0a35c43ee3458bac4761c" name="a150ef74e49e0a35c43ee3458bac4761c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a150ef74e49e0a35c43ee3458bac4761c">◆ </a></span>SetSaveEntryValueCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::SaveData::SetSaveEntryValueCount </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the count value of a save entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The key/name of the entry. </td></tr>
<tr><td class="paramname">count</td><td>The count value to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the entry was not found. </dd></dl>
</div>
</div>
<a id="a6ce196abfcfae9807ae88bb13936dad1" name="a6ce196abfcfae9807ae88bb13936dad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ce196abfcfae9807ae88bb13936dad1">◆ </a></span>SetSaveEntryValueFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::SaveData::SetSaveEntryValueFlags </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the flags of a save entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The key/name of the entry. </td></tr>
<tr><td class="paramname">flags</td><td>The flags value to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the entry was not found. </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a77266901ea3f37f040b570804da9893d" name="a77266901ea3f37f040b570804da9893d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77266901ea3f37f040b570804da9893d">◆ </a></span>g_SaveArraySize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t * ModAPI::SaveData::g_SaveArraySize = nullptr</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the number of entries in the save data array. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceModAPI.html">ModAPI</a></li><li class="navelem"><a class="el" href="namespaceModAPI_1_1SaveData.html">SaveData</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.9.8 </li>
</ul>
</div>
</body>
</html>