mirror
/
SpaghettiKart
mirror of https://github.com/HarbourMasters/SpaghettiKart
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SpaghettiKart/classGameExtractor.html

310 lines
14 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.10.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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Mario Kart 64: GameExtractor Class Reference</title>
<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="resize.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>
<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"/>
<link href="docs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.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">Mario Kart 64
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
$(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 */
$(function(){initNavTree('classGameExtractor.html',''); initResizable(true); });
/* @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-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle"><div class="title">GameExtractor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="GameExtractor_8h_source.html">GameExtractor.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for GameExtractor:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classGameExtractor__coll__graph.svg" width="224" height="124"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a62a6158e90fd2366e4780164d3571f8c" id="r_a62a6158e90fd2366e4780164d3571f8c"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62a6158e90fd2366e4780164d3571f8c">ValidateChecksum</a> () const</td></tr>
<tr class="separator:a62a6158e90fd2366e4780164d3571f8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10cbcd1aac0aa869fdde0d3f1d502b45" id="r_a10cbcd1aac0aa869fdde0d3f1d502b45"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a10cbcd1aac0aa869fdde0d3f1d502b45">SelectGameFromUI</a> ()</td></tr>
<tr class="separator:a10cbcd1aac0aa869fdde0d3f1d502b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a787a62ed41a6f9e69d355810b3c8fe78" id="r_a787a62ed41a6f9e69d355810b3c8fe78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a787a62ed41a6f9e69d355810b3c8fe78">GetRoms</a> (std::vector&lt; std::string &gt; &amp;roms)</td></tr>
<tr class="separator:a787a62ed41a6f9e69d355810b3c8fe78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3eee313b86c230c3fee5f7a5ce120df3" id="r_a3eee313b86c230c3fee5f7a5ce120df3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3eee313b86c230c3fee5f7a5ce120df3">GenerateOTR</a> () const</td></tr>
<tr class="separator:a3eee313b86c230c3fee5f7a5ce120df3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a068ee2ee209e80be83ce70c134eec895" id="r_a068ee2ee209e80be83ce70c134eec895"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a068ee2ee209e80be83ce70c134eec895">GenAssetFile</a> ()</td></tr>
<tr class="separator:a068ee2ee209e80be83ce70c134eec895"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a7e90279a7db81dee58a4dfd4a0cb2745" id="r_a7e90279a7db81dee58a4dfd4a0cb2745"><td class="memItemLeft" align="right" valign="top">fs::path&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e90279a7db81dee58a4dfd4a0cb2745">mGamePath</a></td></tr>
<tr class="separator:a7e90279a7db81dee58a4dfd4a0cb2745"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada063d80b026e2d48266dddb3aaaf027" id="r_ada063d80b026e2d48266dddb3aaaf027"><td class="memItemLeft" align="right" valign="top">std::vector&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ada063d80b026e2d48266dddb3aaaf027">mGameData</a></td></tr>
<tr class="separator:ada063d80b026e2d48266dddb3aaaf027"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a068ee2ee209e80be83ce70c134eec895" name="a068ee2ee209e80be83ce70c134eec895"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a068ee2ee209e80be83ce70c134eec895">&#9670;&#160;</a></span>GenAssetFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool GameExtractor::GenAssetFile </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3eee313b86c230c3fee5f7a5ce120df3" name="a3eee313b86c230c3fee5f7a5ce120df3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eee313b86c230c3fee5f7a5ce120df3">&#9670;&#160;</a></span>GenerateOTR()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool GameExtractor::GenerateOTR </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a787a62ed41a6f9e69d355810b3c8fe78" name="a787a62ed41a6f9e69d355810b3c8fe78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a787a62ed41a6f9e69d355810b3c8fe78">&#9670;&#160;</a></span>GetRoms()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GameExtractor::GetRoms </td>
<td>(</td>
<td class="paramtype">std::vector&lt; std::string &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>roms</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classGameExtractor_a787a62ed41a6f9e69d355810b3c8fe78_icgraph.svg" width="454" height="51"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a10cbcd1aac0aa869fdde0d3f1d502b45" name="a10cbcd1aac0aa869fdde0d3f1d502b45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10cbcd1aac0aa869fdde0d3f1d502b45">&#9670;&#160;</a></span>SelectGameFromUI()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool GameExtractor::SelectGameFromUI </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classGameExtractor_a10cbcd1aac0aa869fdde0d3f1d502b45_cgraph.svg" width="100%" height="431"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div>
</div>
<a id="a62a6158e90fd2366e4780164d3571f8c" name="a62a6158e90fd2366e4780164d3571f8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62a6158e90fd2366e4780164d3571f8c">&#9670;&#160;</a></span>ValidateChecksum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::optional&lt; std::string &gt; GameExtractor::ValidateChecksum </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="ada063d80b026e2d48266dddb3aaaf027" name="ada063d80b026e2d48266dddb3aaaf027"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada063d80b026e2d48266dddb3aaaf027">&#9670;&#160;</a></span>mGameData</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;uint8_t&gt; GameExtractor::mGameData</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7e90279a7db81dee58a4dfd4a0cb2745" name="a7e90279a7db81dee58a4dfd4a0cb2745"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e90279a7db81dee58a4dfd4a0cb2745">&#9670;&#160;</a></span>mGamePath</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fs::path GameExtractor::mGamePath</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/port/<a class="el" href="GameExtractor_8h_source.html">GameExtractor.h</a></li>
<li>src/port/<a class="el" href="GameExtractor_8cpp.html">GameExtractor.cpp</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="classGameExtractor.html">GameExtractor</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.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink