MIO-Modding.github.io/structModAPI_1_1SaveData_1_1SaveEntry.html at main · MIO-Modding/MIO-Modding.github.io · GitHub

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
<!-- 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::SaveEntry Struct 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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structModAPI_1_1SaveData_1_1SaveEntry.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="#pub-attribs">Public Attributes</a> &#124;
<a href="structModAPI_1_1SaveData_1_1SaveEntry-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ModAPI::SaveData::SaveEntry Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>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></p>

<p><code>#include &lt;<a class="el" href="mio-modding-api_8h_source.html">mio-modding-api.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a16e307fa8e25b3347f00e670a2e46fd4" id="r_a16e307fa8e25b3347f00e670a2e46fd4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html#a16e307fa8e25b3347f00e670a2e46fd4">hash</a></td></tr>
<tr class="memdesc:a16e307fa8e25b3347f00e670a2e46fd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hash of the entry. Currently unknown how this is calculated - do not use.  <br /></td></tr>
<tr class="separator:a16e307fa8e25b3347f00e670a2e46fd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8406becdf96af14148471932c5195bb3" id="r_a8406becdf96af14148471932c5195bb3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html#a8406becdf96af14148471932c5195bb3">padding</a></td></tr>
<tr class="memdesc:a8406becdf96af14148471932c5195bb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alignment padding - do not use.  <br /></td></tr>
<tr class="separator:a8406becdf96af14148471932c5195bb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79c769b1456e60b1aba1edd788dd0d77" id="r_a79c769b1456e60b1aba1edd788dd0d77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structModAPI_1_1SaveData_1_1GameString.html">GameString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html#a79c769b1456e60b1aba1edd788dd0d77">entry_name</a></td></tr>
<tr class="memdesc:a79c769b1456e60b1aba1edd788dd0d77"><td class="mdescLeft">&#160;</td><td class="mdescRight">The key/name of this save entry.  <br /></td></tr>
<tr class="separator:a79c769b1456e60b1aba1edd788dd0d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d1b4c818691168022adc95cf1340400" id="r_a9d1b4c818691168022adc95cf1340400"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntryValue.html">SaveEntryValue</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html#a9d1b4c818691168022adc95cf1340400">value</a></td></tr>
<tr class="memdesc:a9d1b4c818691168022adc95cf1340400"><td class="mdescLeft">&#160;</td><td class="mdescRight">The value payload of this entry.  <br /></td></tr>
<tr class="separator:a9d1b4c818691168022adc95cf1340400"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><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><h2 class="groupheader">Member Data Documentation</h2>
<a id="a79c769b1456e60b1aba1edd788dd0d77" name="a79c769b1456e60b1aba1edd788dd0d77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79c769b1456e60b1aba1edd788dd0d77">&#9670;&#160;</a></span>entry_name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structModAPI_1_1SaveData_1_1GameString.html">GameString</a> ModAPI::SaveData::SaveEntry::entry_name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The key/name of this save entry. </p>

</div>
</div>
<a id="a16e307fa8e25b3347f00e670a2e46fd4" name="a16e307fa8e25b3347f00e670a2e46fd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16e307fa8e25b3347f00e670a2e46fd4">&#9670;&#160;</a></span>hash</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t ModAPI::SaveData::SaveEntry::hash</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Hash of the entry. Currently unknown how this is calculated - do not use. </p>

</div>
</div>
<a id="a8406becdf96af14148471932c5195bb3" name="a8406becdf96af14148471932c5195bb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8406becdf96af14148471932c5195bb3">&#9670;&#160;</a></span>padding</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t ModAPI::SaveData::SaveEntry::padding</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Alignment padding - do not use. </p>

</div>
</div>
<a id="a9d1b4c818691168022adc95cf1340400" name="a9d1b4c818691168022adc95cf1340400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d1b4c818691168022adc95cf1340400">&#9670;&#160;</a></span>value</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntryValue.html">SaveEntryValue</a> ModAPI::SaveData::SaveEntry::value</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The value payload of this entry. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>mio-modding-api/<a class="el" href="mio-modding-api_8h_source.html">mio-modding-api.h</a></li>
</ul>
</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="navelem"><a class="el" href="structModAPI_1_1SaveData_1_1SaveEntry.html">SaveEntry</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>