MIO-Modding.github.io/namespaceModAPI_1_1Enums.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
<!-- 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::Enums 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&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('namespaceModAPI_1_1Enums.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="#enum-members">Enumerations</a>  </div>
  <div class="headertitle"><div class="title">ModAPI::Enums Namespace Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Enumerations used by the API.
<a href="namespaceModAPI_1_1Enums.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a30663a5e0b7359c96dcc76db6a2c6736" id="r_a30663a5e0b7359c96dcc76db6a2c6736"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">MenuState</a> { <br />
&#160;&#160;<a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736a72f38ae238ec62759f7d6e101b36bf68">Start</a>
, <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736ae13b9427d0110a1e4decd9bc92a8456c">Splashes</a>
, <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736a55d55f0265732e6d51a093fcb6b8a277">Shader_spinner</a>
, <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736a7b3f5e16011adbb52f7e6afd432194ee">Main_menu</a>
, <br />
&#160;&#160;<a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736a0177c8a316e96a73a6ba49d6b1bec455">Game</a>
, <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736a2ef8c751050238faa1db55c726ab393f">Credits</a>
, <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736a2490717f2013e5084a43760f527b48ed">Exit</a>
<br />
 }</td></tr>
<tr class="memdesc:a30663a5e0b7359c96dcc76db6a2c6736"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents the current high-level state of the game's menu system. The names match the names used internally by the game.  <a href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">More...</a><br /></td></tr>
<tr class="separator:a30663a5e0b7359c96dcc76db6a2c6736"><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>Enumerations used by the API. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a30663a5e0b7359c96dcc76db6a2c6736" name="a30663a5e0b7359c96dcc76db6a2c6736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30663a5e0b7359c96dcc76db6a2c6736">&#9670;&#160;</a></span>MenuState</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">ModAPI::Enums::MenuState</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Represents the current high-level state of the game's menu system. The names match the names used internally by the game. </p>
<p>Read via <a class="el" href="namespaceModAPI_1_1Util.html#a00a4c824af319379e0a6a38b36c0fae5" title="Gets the current menu state of the game.">Util::GetGameMenuState()</a> and written via <a class="el" href="namespaceModAPI_1_1Util.html#a4978974501e64eb7c1f53f94a93a88ed" title="Sets the current menu state of the game.">Util::SetGameMenuState()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736a72f38ae238ec62759f7d6e101b36bf68" name="a30663a5e0b7359c96dcc76db6a2c6736a72f38ae238ec62759f7d6e101b36bf68"></a>Start&#160;</td><td class="fielddoc"><p>Initial startup state. </p>
</td></tr>
<tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736ae13b9427d0110a1e4decd9bc92a8456c" name="a30663a5e0b7359c96dcc76db6a2c6736ae13b9427d0110a1e4decd9bc92a8456c"></a>Splashes&#160;</td><td class="fielddoc"><p>Splash screen sequence. </p>
</td></tr>
<tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736a55d55f0265732e6d51a093fcb6b8a277" name="a30663a5e0b7359c96dcc76db6a2c6736a55d55f0265732e6d51a093fcb6b8a277"></a>Shader_spinner&#160;</td><td class="fielddoc"><p>Shader compilation loading screen. </p>
</td></tr>
<tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736a7b3f5e16011adbb52f7e6afd432194ee" name="a30663a5e0b7359c96dcc76db6a2c6736a7b3f5e16011adbb52f7e6afd432194ee"></a>Main_menu&#160;</td><td class="fielddoc"><p>Main menu is active. </p>
</td></tr>
<tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736a0177c8a316e96a73a6ba49d6b1bec455" name="a30663a5e0b7359c96dcc76db6a2c6736a0177c8a316e96a73a6ba49d6b1bec455"></a>Game&#160;</td><td class="fielddoc"><p>A save is loaded and the game is running. </p>
</td></tr>
<tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736a2ef8c751050238faa1db55c726ab393f" name="a30663a5e0b7359c96dcc76db6a2c6736a2ef8c751050238faa1db55c726ab393f"></a>Credits&#160;</td><td class="fielddoc"><p>Credits sequence. </p>
</td></tr>
<tr><td class="fieldname"><a id="a30663a5e0b7359c96dcc76db6a2c6736a2490717f2013e5084a43760f527b48ed" name="a30663a5e0b7359c96dcc76db6a2c6736a2490717f2013e5084a43760f527b48ed"></a>Exit&#160;</td><td class="fielddoc"><p>Game is shutting down. </p>
</td></tr>
</table>

</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_1Enums.html">Enums</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>