mirror of https://github.com/zeldaret/tmc
318 lines
18 KiB
HTML
318 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>include/save.h file | The Minish Cap Docs</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
|
<link rel="stylesheet" href="style.css" />
|
|
<link rel="icon" href="https://zelda64.dev/favicon.ico" type="image/vnd.microsoft.icon" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#22272e" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
|
|
<a href="https://github.com/zeldaret/tmc">The Minish Cap</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
|
|
</span>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
<li><a href="modules.html">Modules</a></li>
|
|
<li><a href="pages.html">Pages</a></li>
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="3">
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path" />
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
<span class="m-breadcrumb"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a>/</span>save.h <span class="m-thin">file</span>
|
|
</h1>
|
|
<p><span></span></p>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#nested-classes">Classes</a></li>
|
|
<li><a href="#enum-members">Enums</a></li>
|
|
<li><a href="#func-members">Functions</a></li>
|
|
<li><a href="#var-members">Variables</a></li>
|
|
<li><a href="#define-members">Defines</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<section id="nested-classes">
|
|
<h2><a href="#nested-classes">Classes</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
struct <a href="structKinstoneSave.html" class="m-doc">KinstoneSave</a>
|
|
</dt>
|
|
<dd>Contains save data regarding kinstones.</dd>
|
|
<dt>
|
|
struct <a href="structSaveFile.html" class="m-doc">SaveFile</a>
|
|
</dt>
|
|
<dd>Contains all information about a save file.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="enum-members">
|
|
<h2><a href="#enum-members">Enums</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a85868e93184e48095ce0f366c7494203">
|
|
<span class="m-doc-wrap-bumper">enum <a href="#a85868e93184e48095ce0f366c7494203" class="m-doc-self">SaveResult</a> { </span><span class="m-doc-wrap"><a href="#a85868e93184e48095ce0f366c7494203a8f2d01928d2fb471e59079c737862d31" class="m-doc">SAVE_BUSY</a> = 0,
|
|
<a href="#a85868e93184e48095ce0f366c7494203aabd47dc6f0988d79ed5d8e6733202871" class="m-doc">SAVE_OK</a> = 1,
|
|
<a href="#a85868e93184e48095ce0f366c7494203a1cd46854c3ea634bbe32f4fc07027a22" class="m-doc">SAVE_ERROR</a> = -1 }</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
<dt id="a6c2df2fe83b87c5fb34adb55c32b6ff2">
|
|
<span class="m-doc-wrap-bumper">enum <a href="#a6c2df2fe83b87c5fb34adb55c32b6ff2" class="m-doc-self">SaveState</a> { </span><span class="m-doc-wrap"><a href="#a6c2df2fe83b87c5fb34adb55c32b6ff2a4fd22ca5017dd6d40f6f0f88e1469e1b" class="m-doc">SAVE_INIT</a>,
|
|
<a href="#a6c2df2fe83b87c5fb34adb55c32b6ff2a8c91165ff9587f21f6e907a086831ee3" class="m-doc">SAVE_IN_PROGRESS</a>,
|
|
<a href="#a6c2df2fe83b87c5fb34adb55c32b6ff2ab5d76ed302ff9050c984806b6114fd5e" class="m-doc">SAVE_DONE</a> }</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="func-members">
|
|
<h2><a href="#func-members">Functions</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#af7d0f3711c94ca74090016728f254c8c" class="m-doc">HandleSave</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> idx) -> <a href="save_8h.html#a85868e93184e48095ce0f366c7494203" class="m-doc">SaveResult</a></span>
|
|
</dt>
|
|
<dd>Attempt to save the game.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ac9863e749b0268c6dddb6345e7a7efdc" class="m-doc">InitSaveData</a>(</span><span class="m-doc-wrap">void) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd>Initialize the save system.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a2f2e887efc882fb369b1b69c763c657e" class="m-doc">ReadSaveHeader</a>(</span><span class="m-doc-wrap"><a href="structSaveHeader.html" class="m-doc">SaveHeader</a>* saveHeader) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd>Read save header.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a24972626dc087cd61597b7a9a9b6a11d" class="m-doc">WriteSaveHeader</a>(</span><span class="m-doc-wrap"><a href="structSaveHeader.html" class="m-doc">SaveHeader</a>* saveHeader) -> <a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a></span>
|
|
</dt>
|
|
<dd>Write save header.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#ad1b556c9b3c6faba3d2f12cc4f96638b" class="m-doc">ReadSaveFile</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> index,
|
|
<a href="structSaveFile.html" class="m-doc">SaveFile</a>* saveFile) -> <a href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4" class="m-doc">s32</a></span>
|
|
</dt>
|
|
<dd>Read save file.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a href="#aca3aa86439ed6d8fadfd38f919a1b8d5" class="m-doc">SetFileStatusDeleted</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> index)</span>
|
|
</dt>
|
|
<dd>Mark a save file as deleted.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">void <a href="#a4d76e084a3119be6cb1c429d9b8a0e56" class="m-doc">UpdateGlobalProgress</a>(</span><span class="m-doc-wrap">void)</span>
|
|
</dt>
|
|
<dd>Update the global progress (0 - 10).</dd>
|
|
<dt id="a27a292c8adc2956c1df437df982dadb4">
|
|
<span class="m-doc-wrap-bumper">void <a href="#a27a292c8adc2956c1df437df982dadb4" class="m-doc-self">sub_0807CD9C</a>(</span><span class="m-doc-wrap">void)</span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="var-members">
|
|
<h2><a href="#var-members">Variables</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a122a38c931dec036dbe766f4495a19b3">
|
|
<a href="structSaveFile.html" class="m-doc">SaveFile</a> <a href="#a122a38c931dec036dbe766f4495a19b3" class="m-doc-self">gSave</a>
|
|
</dt>
|
|
<dd>The current save file.</dd>
|
|
<dt id="aa56a6edc21897ca3c7db291af4862dd6">
|
|
const char <a href="#aa56a6edc21897ca3c7db291af4862dd6" class="m-doc-self">gUnk_0811E470</a>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section id="define-members">
|
|
<h2><a href="#define-members">Defines</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="a610ce22de673afc7b1e8b0e7b3c9fe7a">
|
|
<span class="m-doc-wrap-bumper">#define <a href="#a610ce22de673afc7b1e8b0e7b3c9fe7a" class="m-doc-self">FILENAME_LENGTH</a></span>
|
|
</dt>
|
|
<dd><span></span></dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Function documentation</h2>
|
|
<section class="m-doc-details" id="af7d0f3711c94ca74090016728f254c8c"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a href="save_8h.html#a85868e93184e48095ce0f366c7494203" class="m-doc">SaveResult</a> </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af7d0f3711c94ca74090016728f254c8c" class="m-doc-self">HandleSave</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> idx)</span></span>
|
|
</h3>
|
|
<p>Attempt to save the game.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">idx</td>
|
|
<td>The save slot.</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td><a href="save_8h.html#a85868e93184e48095ce0f366c7494203" class="m-doc">SaveResult</a> result.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ac9863e749b0268c6dddb6345e7a7efdc"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ac9863e749b0268c6dddb6345e7a7efdc" class="m-doc-self">InitSaveData</a>(</span><span class="m-doc-wrap">void)</span></span>
|
|
</h3>
|
|
<p>Initialize the save system.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<tfoot>
|
|
<tr>
|
|
<th style="width: 1%">Returns</th>
|
|
<td>Success</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a2f2e887efc882fb369b1b69c763c657e"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a2f2e887efc882fb369b1b69c763c657e" class="m-doc-self">ReadSaveHeader</a>(</span><span class="m-doc-wrap"><a href="structSaveHeader.html" class="m-doc">SaveHeader</a>* saveHeader)</span></span>
|
|
</h3>
|
|
<p>Read save header.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<tfoot>
|
|
<tr>
|
|
<th style="width: 1%">Returns</th>
|
|
<td>Success.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a24972626dc087cd61597b7a9a9b6a11d"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a24972626dc087cd61597b7a9a9b6a11d" class="m-doc-self">WriteSaveHeader</a>(</span><span class="m-doc-wrap"><a href="structSaveHeader.html" class="m-doc">SaveHeader</a>* saveHeader)</span></span>
|
|
</h3>
|
|
<p>Write save header.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<tfoot>
|
|
<tr>
|
|
<th style="width: 1%">Returns</th>
|
|
<td>Success.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="ad1b556c9b3c6faba3d2f12cc4f96638b"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"><a href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4" class="m-doc">s32</a> </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad1b556c9b3c6faba3d2f12cc4f96638b" class="m-doc-self">ReadSaveFile</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> index,
|
|
<a href="structSaveFile.html" class="m-doc">SaveFile</a>* saveFile)</span></span>
|
|
</h3>
|
|
<p>Read save file.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<tfoot>
|
|
<tr>
|
|
<th style="width: 1%">Returns</th>
|
|
<td>Success.</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="aca3aa86439ed6d8fadfd38f919a1b8d5"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aca3aa86439ed6d8fadfd38f919a1b8d5" class="m-doc-self">SetFileStatusDeleted</a>(</span><span class="m-doc-wrap"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba" class="m-doc">u32</a> index)</span></span>
|
|
</h3>
|
|
<p>Mark a save file as deleted.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">index</td>
|
|
<td>The save file index.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a4d76e084a3119be6cb1c429d9b8a0e56"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4d76e084a3119be6cb1c429d9b8a0e56" class="m-doc-self">UpdateGlobalProgress</a>(</span><span class="m-doc-wrap">void)</span></span>
|
|
</h3>
|
|
<p>Update the global progress (0 - 10).</p>
|
|
<p>There are 10 different indicators of game completion: 9 : Flag SEIIKI_STAINED_GLASS 8 : Flag LV5_CLEAR 7 : Flag OUBO_KAKERA 6 : Flag LV4_CLEAR 5 : Flag LV3_CLEAR 4 : Flag SOUGEN_08_TORITSUKI 2 : Flag LV1_CLEAR 1 : Default }</p>
|
|
</div></section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script>
|
|
Search.download(window.location.pathname.substr(0, window.location.pathname.lastIndexOf('/') + 1) + 'searchdata-v2.bin');
|
|
</script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<p>The Minish Cap Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.1 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|